@databolsa/sdk 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +56 -0
- package/package.json +45 -0
- package/src/client.ts +148 -0
- package/src/http-client.ts +412 -0
- package/src/index.ts +26 -0
- package/src/schema.ts +2466 -0
- package/src/types.ts +90 -0
package/src/schema.ts
ADDED
|
@@ -0,0 +1,2466 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
export interface paths {
|
|
7
|
+
"/v1/health": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
13
|
+
};
|
|
14
|
+
/** Status da API e frescor dos dados */
|
|
15
|
+
get: operations["getHealth"];
|
|
16
|
+
put?: never;
|
|
17
|
+
post?: never;
|
|
18
|
+
delete?: never;
|
|
19
|
+
options?: never;
|
|
20
|
+
head?: never;
|
|
21
|
+
patch?: never;
|
|
22
|
+
trace?: never;
|
|
23
|
+
};
|
|
24
|
+
"/v1/companies": {
|
|
25
|
+
parameters: {
|
|
26
|
+
query?: never;
|
|
27
|
+
header?: never;
|
|
28
|
+
path?: never;
|
|
29
|
+
cookie?: never;
|
|
30
|
+
};
|
|
31
|
+
/** Lista companhias abertas (cadastro CVM) */
|
|
32
|
+
get: operations["listCompanies"];
|
|
33
|
+
put?: never;
|
|
34
|
+
post?: never;
|
|
35
|
+
delete?: never;
|
|
36
|
+
options?: never;
|
|
37
|
+
head?: never;
|
|
38
|
+
patch?: never;
|
|
39
|
+
trace?: never;
|
|
40
|
+
};
|
|
41
|
+
"/v1/companies/{cvm_code}": {
|
|
42
|
+
parameters: {
|
|
43
|
+
query?: never;
|
|
44
|
+
header?: never;
|
|
45
|
+
path?: never;
|
|
46
|
+
cookie?: never;
|
|
47
|
+
};
|
|
48
|
+
/** Companhia por código CVM */
|
|
49
|
+
get: operations["getCompany"];
|
|
50
|
+
put?: never;
|
|
51
|
+
post?: never;
|
|
52
|
+
delete?: never;
|
|
53
|
+
options?: never;
|
|
54
|
+
head?: never;
|
|
55
|
+
patch?: never;
|
|
56
|
+
trace?: never;
|
|
57
|
+
};
|
|
58
|
+
"/v1/companies/{cvm_code}/documents": {
|
|
59
|
+
parameters: {
|
|
60
|
+
query?: never;
|
|
61
|
+
header?: never;
|
|
62
|
+
path?: never;
|
|
63
|
+
cookie?: never;
|
|
64
|
+
};
|
|
65
|
+
/** Documentos e comunicados (IPE/CVM) */
|
|
66
|
+
get: operations["listCompanyDocuments"];
|
|
67
|
+
put?: never;
|
|
68
|
+
post?: never;
|
|
69
|
+
delete?: never;
|
|
70
|
+
options?: never;
|
|
71
|
+
head?: never;
|
|
72
|
+
patch?: never;
|
|
73
|
+
trace?: never;
|
|
74
|
+
};
|
|
75
|
+
"/v1/stocks/{ticker}": {
|
|
76
|
+
parameters: {
|
|
77
|
+
query?: never;
|
|
78
|
+
header?: never;
|
|
79
|
+
path?: never;
|
|
80
|
+
cookie?: never;
|
|
81
|
+
};
|
|
82
|
+
/** Perfil e última cotação do papel */
|
|
83
|
+
get: operations["getStock"];
|
|
84
|
+
put?: never;
|
|
85
|
+
post?: never;
|
|
86
|
+
delete?: never;
|
|
87
|
+
options?: never;
|
|
88
|
+
head?: never;
|
|
89
|
+
patch?: never;
|
|
90
|
+
trace?: never;
|
|
91
|
+
};
|
|
92
|
+
"/v1/stocks/{ticker}/quotes": {
|
|
93
|
+
parameters: {
|
|
94
|
+
query?: never;
|
|
95
|
+
header?: never;
|
|
96
|
+
path?: never;
|
|
97
|
+
cookie?: never;
|
|
98
|
+
};
|
|
99
|
+
/**
|
|
100
|
+
* Série de cotações OHLCV
|
|
101
|
+
* @description Ajustada por eventos por default; `from`/`to` filtram o período (from <= to).
|
|
102
|
+
*/
|
|
103
|
+
get: operations["listQuotes"];
|
|
104
|
+
put?: never;
|
|
105
|
+
post?: never;
|
|
106
|
+
delete?: never;
|
|
107
|
+
options?: never;
|
|
108
|
+
head?: never;
|
|
109
|
+
patch?: never;
|
|
110
|
+
trace?: never;
|
|
111
|
+
};
|
|
112
|
+
"/v1/stocks/{ticker}/indicators": {
|
|
113
|
+
parameters: {
|
|
114
|
+
query?: never;
|
|
115
|
+
header?: never;
|
|
116
|
+
path?: never;
|
|
117
|
+
cookie?: never;
|
|
118
|
+
};
|
|
119
|
+
/** Indicadores fundamentalistas (snapshot TTM) */
|
|
120
|
+
get: operations["getStockIndicators"];
|
|
121
|
+
put?: never;
|
|
122
|
+
post?: never;
|
|
123
|
+
delete?: never;
|
|
124
|
+
options?: never;
|
|
125
|
+
head?: never;
|
|
126
|
+
patch?: never;
|
|
127
|
+
trace?: never;
|
|
128
|
+
};
|
|
129
|
+
"/v1/stocks/{ticker}/indicators/history": {
|
|
130
|
+
parameters: {
|
|
131
|
+
query?: never;
|
|
132
|
+
header?: never;
|
|
133
|
+
path?: never;
|
|
134
|
+
cookie?: never;
|
|
135
|
+
};
|
|
136
|
+
/** Histórico de um indicador (trimestral) */
|
|
137
|
+
get: operations["getStockIndicatorHistory"];
|
|
138
|
+
put?: never;
|
|
139
|
+
post?: never;
|
|
140
|
+
delete?: never;
|
|
141
|
+
options?: never;
|
|
142
|
+
head?: never;
|
|
143
|
+
patch?: never;
|
|
144
|
+
trace?: never;
|
|
145
|
+
};
|
|
146
|
+
"/v1/stocks/{ticker}/dividends": {
|
|
147
|
+
parameters: {
|
|
148
|
+
query?: never;
|
|
149
|
+
header?: never;
|
|
150
|
+
path?: never;
|
|
151
|
+
cookie?: never;
|
|
152
|
+
};
|
|
153
|
+
/** Proventos (dividendos e JCP) */
|
|
154
|
+
get: operations["listDividends"];
|
|
155
|
+
put?: never;
|
|
156
|
+
post?: never;
|
|
157
|
+
delete?: never;
|
|
158
|
+
options?: never;
|
|
159
|
+
head?: never;
|
|
160
|
+
patch?: never;
|
|
161
|
+
trace?: never;
|
|
162
|
+
};
|
|
163
|
+
"/v1/stocks/{ticker}/events": {
|
|
164
|
+
parameters: {
|
|
165
|
+
query?: never;
|
|
166
|
+
header?: never;
|
|
167
|
+
path?: never;
|
|
168
|
+
cookie?: never;
|
|
169
|
+
};
|
|
170
|
+
/** Eventos societários (desdobramentos, grupamentos, bonificações) */
|
|
171
|
+
get: operations["listCorporateEvents"];
|
|
172
|
+
put?: never;
|
|
173
|
+
post?: never;
|
|
174
|
+
delete?: never;
|
|
175
|
+
options?: never;
|
|
176
|
+
head?: never;
|
|
177
|
+
patch?: never;
|
|
178
|
+
trace?: never;
|
|
179
|
+
};
|
|
180
|
+
"/v1/stocks/{ticker}/insider": {
|
|
181
|
+
parameters: {
|
|
182
|
+
query?: never;
|
|
183
|
+
header?: never;
|
|
184
|
+
path?: never;
|
|
185
|
+
cookie?: never;
|
|
186
|
+
};
|
|
187
|
+
/** Movimentações de insiders (CVM VLMO, por mês) */
|
|
188
|
+
get: operations["listInsiderMoves"];
|
|
189
|
+
put?: never;
|
|
190
|
+
post?: never;
|
|
191
|
+
delete?: never;
|
|
192
|
+
options?: never;
|
|
193
|
+
head?: never;
|
|
194
|
+
patch?: never;
|
|
195
|
+
trace?: never;
|
|
196
|
+
};
|
|
197
|
+
"/v1/screener/stocks": {
|
|
198
|
+
parameters: {
|
|
199
|
+
query?: never;
|
|
200
|
+
header?: never;
|
|
201
|
+
path?: never;
|
|
202
|
+
cookie?: never;
|
|
203
|
+
};
|
|
204
|
+
/** Filtra ações por múltiplos critérios fundamentalistas */
|
|
205
|
+
get: operations["screenStocks"];
|
|
206
|
+
put?: never;
|
|
207
|
+
post?: never;
|
|
208
|
+
delete?: never;
|
|
209
|
+
options?: never;
|
|
210
|
+
head?: never;
|
|
211
|
+
patch?: never;
|
|
212
|
+
trace?: never;
|
|
213
|
+
};
|
|
214
|
+
"/v1/screener/fiis": {
|
|
215
|
+
parameters: {
|
|
216
|
+
query?: never;
|
|
217
|
+
header?: never;
|
|
218
|
+
path?: never;
|
|
219
|
+
cookie?: never;
|
|
220
|
+
};
|
|
221
|
+
/** Universo de FIIs filtrável por segmento e tijolo/papel */
|
|
222
|
+
get: operations["screenFiis"];
|
|
223
|
+
put?: never;
|
|
224
|
+
post?: never;
|
|
225
|
+
delete?: never;
|
|
226
|
+
options?: never;
|
|
227
|
+
head?: never;
|
|
228
|
+
patch?: never;
|
|
229
|
+
trace?: never;
|
|
230
|
+
};
|
|
231
|
+
"/v1/macro/gears": {
|
|
232
|
+
parameters: {
|
|
233
|
+
query?: never;
|
|
234
|
+
header?: never;
|
|
235
|
+
path?: never;
|
|
236
|
+
cookie?: never;
|
|
237
|
+
};
|
|
238
|
+
/** Engrenagens macro (sinais por seção) */
|
|
239
|
+
get: operations["getMacroGears"];
|
|
240
|
+
put?: never;
|
|
241
|
+
post?: never;
|
|
242
|
+
delete?: never;
|
|
243
|
+
options?: never;
|
|
244
|
+
head?: never;
|
|
245
|
+
patch?: never;
|
|
246
|
+
trace?: never;
|
|
247
|
+
};
|
|
248
|
+
"/v1/macro/regime": {
|
|
249
|
+
parameters: {
|
|
250
|
+
query?: never;
|
|
251
|
+
header?: never;
|
|
252
|
+
path?: never;
|
|
253
|
+
cookie?: never;
|
|
254
|
+
};
|
|
255
|
+
/** Regime econômico (quadrante crescimento × inflação) */
|
|
256
|
+
get: operations["getMacroRegime"];
|
|
257
|
+
put?: never;
|
|
258
|
+
post?: never;
|
|
259
|
+
delete?: never;
|
|
260
|
+
options?: never;
|
|
261
|
+
head?: never;
|
|
262
|
+
patch?: never;
|
|
263
|
+
trace?: never;
|
|
264
|
+
};
|
|
265
|
+
"/v1/macro/expectations": {
|
|
266
|
+
parameters: {
|
|
267
|
+
query?: never;
|
|
268
|
+
header?: never;
|
|
269
|
+
path?: never;
|
|
270
|
+
cookie?: never;
|
|
271
|
+
};
|
|
272
|
+
/** Expectativas Focus (consenso por indicador) */
|
|
273
|
+
get: operations["getMarketExpectations"];
|
|
274
|
+
put?: never;
|
|
275
|
+
post?: never;
|
|
276
|
+
delete?: never;
|
|
277
|
+
options?: never;
|
|
278
|
+
head?: never;
|
|
279
|
+
patch?: never;
|
|
280
|
+
trace?: never;
|
|
281
|
+
};
|
|
282
|
+
"/v1/bonds/tesouro/yield-curve": {
|
|
283
|
+
parameters: {
|
|
284
|
+
query?: never;
|
|
285
|
+
header?: never;
|
|
286
|
+
path?: never;
|
|
287
|
+
cookie?: never;
|
|
288
|
+
};
|
|
289
|
+
/** Curva de juros (Tesouro), um ponto por vencimento */
|
|
290
|
+
get: operations["getYieldCurve"];
|
|
291
|
+
put?: never;
|
|
292
|
+
post?: never;
|
|
293
|
+
delete?: never;
|
|
294
|
+
options?: never;
|
|
295
|
+
head?: never;
|
|
296
|
+
patch?: never;
|
|
297
|
+
trace?: never;
|
|
298
|
+
};
|
|
299
|
+
"/v1/bonds/tesouro": {
|
|
300
|
+
parameters: {
|
|
301
|
+
query?: never;
|
|
302
|
+
header?: never;
|
|
303
|
+
path?: never;
|
|
304
|
+
cookie?: never;
|
|
305
|
+
};
|
|
306
|
+
/** Títulos do Tesouro Direto (taxas e preços) */
|
|
307
|
+
get: operations["listTesouroBonds"];
|
|
308
|
+
put?: never;
|
|
309
|
+
post?: never;
|
|
310
|
+
delete?: never;
|
|
311
|
+
options?: never;
|
|
312
|
+
head?: never;
|
|
313
|
+
patch?: never;
|
|
314
|
+
trace?: never;
|
|
315
|
+
};
|
|
316
|
+
"/v1/indices": {
|
|
317
|
+
parameters: {
|
|
318
|
+
query?: never;
|
|
319
|
+
header?: never;
|
|
320
|
+
path?: never;
|
|
321
|
+
cookie?: never;
|
|
322
|
+
};
|
|
323
|
+
/** Índices disponíveis (IBOV, IFIX, ...) */
|
|
324
|
+
get: operations["listIndices"];
|
|
325
|
+
put?: never;
|
|
326
|
+
post?: never;
|
|
327
|
+
delete?: never;
|
|
328
|
+
options?: never;
|
|
329
|
+
head?: never;
|
|
330
|
+
patch?: never;
|
|
331
|
+
trace?: never;
|
|
332
|
+
};
|
|
333
|
+
"/v1/indices/{code}/quotes": {
|
|
334
|
+
parameters: {
|
|
335
|
+
query?: never;
|
|
336
|
+
header?: never;
|
|
337
|
+
path?: never;
|
|
338
|
+
cookie?: never;
|
|
339
|
+
};
|
|
340
|
+
/** Série de níveis diários de um índice */
|
|
341
|
+
get: operations["listIndexQuotes"];
|
|
342
|
+
put?: never;
|
|
343
|
+
post?: never;
|
|
344
|
+
delete?: never;
|
|
345
|
+
options?: never;
|
|
346
|
+
head?: never;
|
|
347
|
+
patch?: never;
|
|
348
|
+
trace?: never;
|
|
349
|
+
};
|
|
350
|
+
"/v1/indices/{code}/composition": {
|
|
351
|
+
parameters: {
|
|
352
|
+
query?: never;
|
|
353
|
+
header?: never;
|
|
354
|
+
path?: never;
|
|
355
|
+
cookie?: never;
|
|
356
|
+
};
|
|
357
|
+
/** Composição teórica do índice (carteira) — dados ao vivo pendentes */
|
|
358
|
+
get: operations["getIndexComposition"];
|
|
359
|
+
put?: never;
|
|
360
|
+
post?: never;
|
|
361
|
+
delete?: never;
|
|
362
|
+
options?: never;
|
|
363
|
+
head?: never;
|
|
364
|
+
patch?: never;
|
|
365
|
+
trace?: never;
|
|
366
|
+
};
|
|
367
|
+
"/v1/series": {
|
|
368
|
+
parameters: {
|
|
369
|
+
query?: never;
|
|
370
|
+
header?: never;
|
|
371
|
+
path?: never;
|
|
372
|
+
cookie?: never;
|
|
373
|
+
};
|
|
374
|
+
/** Catálogo de séries (BCB/IBGE/FRED/...) */
|
|
375
|
+
get: operations["listSeries"];
|
|
376
|
+
put?: never;
|
|
377
|
+
post?: never;
|
|
378
|
+
delete?: never;
|
|
379
|
+
options?: never;
|
|
380
|
+
head?: never;
|
|
381
|
+
patch?: never;
|
|
382
|
+
trace?: never;
|
|
383
|
+
};
|
|
384
|
+
"/v1/series/{source}/{series_id}": {
|
|
385
|
+
parameters: {
|
|
386
|
+
query?: never;
|
|
387
|
+
header?: never;
|
|
388
|
+
path?: never;
|
|
389
|
+
cookie?: never;
|
|
390
|
+
};
|
|
391
|
+
/** Observações de uma série (com acumulados opcionais) */
|
|
392
|
+
get: operations["getSeries"];
|
|
393
|
+
put?: never;
|
|
394
|
+
post?: never;
|
|
395
|
+
delete?: never;
|
|
396
|
+
options?: never;
|
|
397
|
+
head?: never;
|
|
398
|
+
patch?: never;
|
|
399
|
+
trace?: never;
|
|
400
|
+
};
|
|
401
|
+
"/v1/fiis/{ticker}": {
|
|
402
|
+
parameters: {
|
|
403
|
+
query?: never;
|
|
404
|
+
header?: never;
|
|
405
|
+
path?: never;
|
|
406
|
+
cookie?: never;
|
|
407
|
+
};
|
|
408
|
+
/** Perfil do fundo imobiliário */
|
|
409
|
+
get: operations["getFii"];
|
|
410
|
+
put?: never;
|
|
411
|
+
post?: never;
|
|
412
|
+
delete?: never;
|
|
413
|
+
options?: never;
|
|
414
|
+
head?: never;
|
|
415
|
+
patch?: never;
|
|
416
|
+
trace?: never;
|
|
417
|
+
};
|
|
418
|
+
"/v1/fiis/{ticker}/indicators": {
|
|
419
|
+
parameters: {
|
|
420
|
+
query?: never;
|
|
421
|
+
header?: never;
|
|
422
|
+
path?: never;
|
|
423
|
+
cookie?: never;
|
|
424
|
+
};
|
|
425
|
+
/** Indicadores do FII (snapshot) */
|
|
426
|
+
get: operations["getFiiIndicators"];
|
|
427
|
+
put?: never;
|
|
428
|
+
post?: never;
|
|
429
|
+
delete?: never;
|
|
430
|
+
options?: never;
|
|
431
|
+
head?: never;
|
|
432
|
+
patch?: never;
|
|
433
|
+
trace?: never;
|
|
434
|
+
};
|
|
435
|
+
"/v1/fiis/{ticker}/indicators/history": {
|
|
436
|
+
parameters: {
|
|
437
|
+
query?: never;
|
|
438
|
+
header?: never;
|
|
439
|
+
path?: never;
|
|
440
|
+
cookie?: never;
|
|
441
|
+
};
|
|
442
|
+
/** Histórico de um indicador do FII (informe mensal) */
|
|
443
|
+
get: operations["getFiiIndicatorHistory"];
|
|
444
|
+
put?: never;
|
|
445
|
+
post?: never;
|
|
446
|
+
delete?: never;
|
|
447
|
+
options?: never;
|
|
448
|
+
head?: never;
|
|
449
|
+
patch?: never;
|
|
450
|
+
trace?: never;
|
|
451
|
+
};
|
|
452
|
+
"/v1/fiis/{ticker}/distributions": {
|
|
453
|
+
parameters: {
|
|
454
|
+
query?: never;
|
|
455
|
+
header?: never;
|
|
456
|
+
path?: never;
|
|
457
|
+
cookie?: never;
|
|
458
|
+
};
|
|
459
|
+
/** Distribuições (rendimentos) do FII */
|
|
460
|
+
get: operations["listFiiDistributions"];
|
|
461
|
+
put?: never;
|
|
462
|
+
post?: never;
|
|
463
|
+
delete?: never;
|
|
464
|
+
options?: never;
|
|
465
|
+
head?: never;
|
|
466
|
+
patch?: never;
|
|
467
|
+
trace?: never;
|
|
468
|
+
};
|
|
469
|
+
"/v1/fiis/{ticker}/reports": {
|
|
470
|
+
parameters: {
|
|
471
|
+
query?: never;
|
|
472
|
+
header?: never;
|
|
473
|
+
path?: never;
|
|
474
|
+
cookie?: never;
|
|
475
|
+
};
|
|
476
|
+
/** Informes mensais do FII */
|
|
477
|
+
get: operations["listFiiReports"];
|
|
478
|
+
put?: never;
|
|
479
|
+
post?: never;
|
|
480
|
+
delete?: never;
|
|
481
|
+
options?: never;
|
|
482
|
+
head?: never;
|
|
483
|
+
patch?: never;
|
|
484
|
+
trace?: never;
|
|
485
|
+
};
|
|
486
|
+
"/v1/bdr": {
|
|
487
|
+
parameters: {
|
|
488
|
+
query?: never;
|
|
489
|
+
header?: never;
|
|
490
|
+
path?: never;
|
|
491
|
+
cookie?: never;
|
|
492
|
+
};
|
|
493
|
+
/** Catálogo de BDRs (recibos de ações estrangeiras) */
|
|
494
|
+
get: operations["listBdrs"];
|
|
495
|
+
put?: never;
|
|
496
|
+
post?: never;
|
|
497
|
+
delete?: never;
|
|
498
|
+
options?: never;
|
|
499
|
+
head?: never;
|
|
500
|
+
patch?: never;
|
|
501
|
+
trace?: never;
|
|
502
|
+
};
|
|
503
|
+
"/v1/bdr/{ticker}": {
|
|
504
|
+
parameters: {
|
|
505
|
+
query?: never;
|
|
506
|
+
header?: never;
|
|
507
|
+
path?: never;
|
|
508
|
+
cookie?: never;
|
|
509
|
+
};
|
|
510
|
+
/** Perfil de um BDR */
|
|
511
|
+
get: operations["getBdr"];
|
|
512
|
+
put?: never;
|
|
513
|
+
post?: never;
|
|
514
|
+
delete?: never;
|
|
515
|
+
options?: never;
|
|
516
|
+
head?: never;
|
|
517
|
+
patch?: never;
|
|
518
|
+
trace?: never;
|
|
519
|
+
};
|
|
520
|
+
"/v1/bdr/{ticker}/quotes": {
|
|
521
|
+
parameters: {
|
|
522
|
+
query?: never;
|
|
523
|
+
header?: never;
|
|
524
|
+
path?: never;
|
|
525
|
+
cookie?: never;
|
|
526
|
+
};
|
|
527
|
+
/**
|
|
528
|
+
* Cotações EOD de um BDR
|
|
529
|
+
* @description Preços do BDR (events_only). BDR fica `adjust_quality='no_event_source'`.
|
|
530
|
+
*/
|
|
531
|
+
get: operations["listBdrQuotes"];
|
|
532
|
+
put?: never;
|
|
533
|
+
post?: never;
|
|
534
|
+
delete?: never;
|
|
535
|
+
options?: never;
|
|
536
|
+
head?: never;
|
|
537
|
+
patch?: never;
|
|
538
|
+
trace?: never;
|
|
539
|
+
};
|
|
540
|
+
"/v1/options/{ticker}/chain": {
|
|
541
|
+
parameters: {
|
|
542
|
+
query?: never;
|
|
543
|
+
header?: never;
|
|
544
|
+
path?: never;
|
|
545
|
+
cookie?: never;
|
|
546
|
+
};
|
|
547
|
+
/**
|
|
548
|
+
* Cadeia de opções vigente de um subjacente
|
|
549
|
+
* @description Séries vivas (não vencidas) que negociaram; filtre por `expiry`/`type`.
|
|
550
|
+
*/
|
|
551
|
+
get: operations["getOptionsChain"];
|
|
552
|
+
put?: never;
|
|
553
|
+
post?: never;
|
|
554
|
+
delete?: never;
|
|
555
|
+
options?: never;
|
|
556
|
+
head?: never;
|
|
557
|
+
patch?: never;
|
|
558
|
+
trace?: never;
|
|
559
|
+
};
|
|
560
|
+
"/v1/options/{ticker}/expiries": {
|
|
561
|
+
parameters: {
|
|
562
|
+
query?: never;
|
|
563
|
+
header?: never;
|
|
564
|
+
path?: never;
|
|
565
|
+
cookie?: never;
|
|
566
|
+
};
|
|
567
|
+
/** Vencimentos disponíveis de um subjacente */
|
|
568
|
+
get: operations["listOptionExpiries"];
|
|
569
|
+
put?: never;
|
|
570
|
+
post?: never;
|
|
571
|
+
delete?: never;
|
|
572
|
+
options?: never;
|
|
573
|
+
head?: never;
|
|
574
|
+
patch?: never;
|
|
575
|
+
trace?: never;
|
|
576
|
+
};
|
|
577
|
+
"/v1/options/{option}/quotes": {
|
|
578
|
+
parameters: {
|
|
579
|
+
query?: never;
|
|
580
|
+
header?: never;
|
|
581
|
+
path?: never;
|
|
582
|
+
cookie?: never;
|
|
583
|
+
};
|
|
584
|
+
/** Histórico EOD de uma série de opção */
|
|
585
|
+
get: operations["listOptionQuotes"];
|
|
586
|
+
put?: never;
|
|
587
|
+
post?: never;
|
|
588
|
+
delete?: never;
|
|
589
|
+
options?: never;
|
|
590
|
+
head?: never;
|
|
591
|
+
patch?: never;
|
|
592
|
+
trace?: never;
|
|
593
|
+
};
|
|
594
|
+
"/v1/crypto/{symbol}/quotes": {
|
|
595
|
+
parameters: {
|
|
596
|
+
query?: never;
|
|
597
|
+
header?: never;
|
|
598
|
+
path?: never;
|
|
599
|
+
cookie?: never;
|
|
600
|
+
};
|
|
601
|
+
/** Candles de um criptoativo (diário; 1h vazio no v1) */
|
|
602
|
+
get: operations["listCryptoQuotes"];
|
|
603
|
+
put?: never;
|
|
604
|
+
post?: never;
|
|
605
|
+
delete?: never;
|
|
606
|
+
options?: never;
|
|
607
|
+
head?: never;
|
|
608
|
+
patch?: never;
|
|
609
|
+
trace?: never;
|
|
610
|
+
};
|
|
611
|
+
"/v1/search": {
|
|
612
|
+
parameters: {
|
|
613
|
+
query?: never;
|
|
614
|
+
header?: never;
|
|
615
|
+
path?: never;
|
|
616
|
+
cookie?: never;
|
|
617
|
+
};
|
|
618
|
+
/** Busca unificada (typeahead) por ações/FIIs/índices/títulos/macro */
|
|
619
|
+
get: operations["search"];
|
|
620
|
+
put?: never;
|
|
621
|
+
post?: never;
|
|
622
|
+
delete?: never;
|
|
623
|
+
options?: never;
|
|
624
|
+
head?: never;
|
|
625
|
+
patch?: never;
|
|
626
|
+
trace?: never;
|
|
627
|
+
};
|
|
628
|
+
"/v1/ingest": {
|
|
629
|
+
parameters: {
|
|
630
|
+
query?: never;
|
|
631
|
+
header?: never;
|
|
632
|
+
path?: never;
|
|
633
|
+
cookie?: never;
|
|
634
|
+
};
|
|
635
|
+
/** Saúde da ingestão (última run, fontes, histórico) */
|
|
636
|
+
get: operations["getIngestHealth"];
|
|
637
|
+
put?: never;
|
|
638
|
+
post?: never;
|
|
639
|
+
delete?: never;
|
|
640
|
+
options?: never;
|
|
641
|
+
head?: never;
|
|
642
|
+
patch?: never;
|
|
643
|
+
trace?: never;
|
|
644
|
+
};
|
|
645
|
+
}
|
|
646
|
+
export type webhooks = Record<string, never>;
|
|
647
|
+
export interface components {
|
|
648
|
+
schemas: {
|
|
649
|
+
Health: {
|
|
650
|
+
/** @enum {string} */
|
|
651
|
+
status: "ok" | "degraded";
|
|
652
|
+
version: string;
|
|
653
|
+
data_freshness: {
|
|
654
|
+
[key: string]: string;
|
|
655
|
+
};
|
|
656
|
+
};
|
|
657
|
+
Problem: {
|
|
658
|
+
type: string;
|
|
659
|
+
title: string;
|
|
660
|
+
status: number;
|
|
661
|
+
detail?: string;
|
|
662
|
+
instance?: string;
|
|
663
|
+
};
|
|
664
|
+
Company: {
|
|
665
|
+
cvm_code: number;
|
|
666
|
+
cnpj: string | null;
|
|
667
|
+
name: string | null;
|
|
668
|
+
/** @description Nome de pregão — null nas fontes abertas */
|
|
669
|
+
trade_name: string | null;
|
|
670
|
+
sector: string | null;
|
|
671
|
+
subsector: string | null;
|
|
672
|
+
listing_segment: string | null;
|
|
673
|
+
tickers: string[];
|
|
674
|
+
/** @description Capital emitido (fontes cruzadas FRE/CVM e B3) */
|
|
675
|
+
shares_outstanding: {
|
|
676
|
+
common: number | null;
|
|
677
|
+
preferred: number | null;
|
|
678
|
+
total: number | null;
|
|
679
|
+
};
|
|
680
|
+
/** @description % de ações em circulação (FRE) */
|
|
681
|
+
free_float_pct: number | null;
|
|
682
|
+
status: string | null;
|
|
683
|
+
has_active_ticker: boolean | null;
|
|
684
|
+
};
|
|
685
|
+
Document: {
|
|
686
|
+
cvm_code: number;
|
|
687
|
+
category: string | null;
|
|
688
|
+
type: string | null;
|
|
689
|
+
subject: string | null;
|
|
690
|
+
reference_date: string | null;
|
|
691
|
+
filed_at: string | null;
|
|
692
|
+
protocol: string | null;
|
|
693
|
+
download_url: string | null;
|
|
694
|
+
has_text: boolean;
|
|
695
|
+
};
|
|
696
|
+
Stock: {
|
|
697
|
+
ticker: string;
|
|
698
|
+
isin: string | null;
|
|
699
|
+
type: components["schemas"]["StockType"] | null;
|
|
700
|
+
company: {
|
|
701
|
+
cvm_code: number | null;
|
|
702
|
+
name: string | null;
|
|
703
|
+
/** @description Papéis (classes) da empresa — cada um analisável em /stocks/{ticker}/indicators */
|
|
704
|
+
tickers: {
|
|
705
|
+
ticker: string;
|
|
706
|
+
type: components["schemas"]["StockType"] | null;
|
|
707
|
+
}[];
|
|
708
|
+
} | null;
|
|
709
|
+
shares_outstanding: number | null;
|
|
710
|
+
latest_quote: {
|
|
711
|
+
date: string;
|
|
712
|
+
close: number | null;
|
|
713
|
+
adjust_type: string | null;
|
|
714
|
+
adjust_quality: string | null;
|
|
715
|
+
};
|
|
716
|
+
};
|
|
717
|
+
/** @enum {string} */
|
|
718
|
+
StockType: "ON" | "PN" | "PNA" | "PNB" | "UNIT";
|
|
719
|
+
Quote: {
|
|
720
|
+
date: string;
|
|
721
|
+
open: number | null;
|
|
722
|
+
high: number | null;
|
|
723
|
+
low: number | null;
|
|
724
|
+
close: number | null;
|
|
725
|
+
/** @description Fechamento bruto (não ajustado), como reportado pela B3 */
|
|
726
|
+
close_raw: number | null;
|
|
727
|
+
/** @description Fechamento de retorno total: ajustado por eventos + proventos reinvestidos (bruto). = close quando não há fonte de proventos (units/FII) */
|
|
728
|
+
close_tr: number | null;
|
|
729
|
+
/** @description Volume financeiro (R$) */
|
|
730
|
+
volume: number | null;
|
|
731
|
+
quantity: number | null;
|
|
732
|
+
/** @description Nº de negócios — null: fonte aberta dá quantidade, não contagem */
|
|
733
|
+
trades: number | null;
|
|
734
|
+
adjusted: boolean;
|
|
735
|
+
adjust_type: string | null;
|
|
736
|
+
adjust_quality: string | null;
|
|
737
|
+
};
|
|
738
|
+
IndicatorValue: {
|
|
739
|
+
name: string;
|
|
740
|
+
label: string;
|
|
741
|
+
/** @description null quando não calculável — ver reason */
|
|
742
|
+
value: number | null;
|
|
743
|
+
/** @enum {string} */
|
|
744
|
+
unit: "ratio" | "percent" | "brl" | "brl_per_share" | "count" | "days";
|
|
745
|
+
reason: string | null;
|
|
746
|
+
reference_date: string | null;
|
|
747
|
+
ttm: boolean;
|
|
748
|
+
lineage: components["schemas"]["Lineage"];
|
|
749
|
+
methodology_url: string;
|
|
750
|
+
};
|
|
751
|
+
Lineage: {
|
|
752
|
+
source: string;
|
|
753
|
+
reference: string;
|
|
754
|
+
url?: string | null;
|
|
755
|
+
};
|
|
756
|
+
Observation: {
|
|
757
|
+
date: string;
|
|
758
|
+
value: number | null;
|
|
759
|
+
};
|
|
760
|
+
Dividend: {
|
|
761
|
+
type: string | null;
|
|
762
|
+
ex_date: string | null;
|
|
763
|
+
payment_date: string | null;
|
|
764
|
+
value_per_share_gross: number | null;
|
|
765
|
+
value_per_share_net: number | null;
|
|
766
|
+
};
|
|
767
|
+
CorporateEvent: {
|
|
768
|
+
type: string | null;
|
|
769
|
+
approved_date: string | null;
|
|
770
|
+
ex_date: string | null;
|
|
771
|
+
factor: number | null;
|
|
772
|
+
detail: string | null;
|
|
773
|
+
};
|
|
774
|
+
InsiderMove: {
|
|
775
|
+
/** @description AAAA-MM */
|
|
776
|
+
reference_month: string;
|
|
777
|
+
net_shares: number | null;
|
|
778
|
+
net_value_brl: number | null;
|
|
779
|
+
buy_value_brl: number | null;
|
|
780
|
+
sell_value_brl: number | null;
|
|
781
|
+
lineage: components["schemas"]["Lineage"];
|
|
782
|
+
};
|
|
783
|
+
ScreenerRow: {
|
|
784
|
+
ticker: string;
|
|
785
|
+
name: string | null;
|
|
786
|
+
sector: string | null;
|
|
787
|
+
indicators: {
|
|
788
|
+
market_cap: number | null;
|
|
789
|
+
pl: number | null;
|
|
790
|
+
pvp: number | null;
|
|
791
|
+
dy: number | null;
|
|
792
|
+
roe: number | null;
|
|
793
|
+
roic: number | null;
|
|
794
|
+
ev_ebitda: number | null;
|
|
795
|
+
div_liq_ebitda: number | null;
|
|
796
|
+
margem_liquida: number | null;
|
|
797
|
+
};
|
|
798
|
+
};
|
|
799
|
+
FiiListRow: {
|
|
800
|
+
ticker: string;
|
|
801
|
+
name: string | null;
|
|
802
|
+
segment: string | null;
|
|
803
|
+
is_paper: boolean;
|
|
804
|
+
reference_date: string | null;
|
|
805
|
+
preco: number | null;
|
|
806
|
+
dy_12m: number | null;
|
|
807
|
+
pvp: number | null;
|
|
808
|
+
vacancia_fisica: number | null;
|
|
809
|
+
patrimonio_liquido: number | null;
|
|
810
|
+
};
|
|
811
|
+
RegimeSignal: {
|
|
812
|
+
name: string;
|
|
813
|
+
value: number | null;
|
|
814
|
+
/** @enum {string|null} */
|
|
815
|
+
direction: "up" | "down" | "flat" | null;
|
|
816
|
+
lineage: components["schemas"]["Lineage"];
|
|
817
|
+
unit?: string | null;
|
|
818
|
+
label?: string | null;
|
|
819
|
+
date?: string | null;
|
|
820
|
+
};
|
|
821
|
+
RegimeSnapshot: {
|
|
822
|
+
as_of: string | null;
|
|
823
|
+
/** @enum {string|null} */
|
|
824
|
+
quadrant: "growth_up_inflation_up" | "growth_up_inflation_down" | "growth_down_inflation_up" | "growth_down_inflation_down" | null;
|
|
825
|
+
growth: {
|
|
826
|
+
/** @enum {string|null} */
|
|
827
|
+
direction: "up" | "down" | "flat" | null;
|
|
828
|
+
signals: components["schemas"]["RegimeSignal"][];
|
|
829
|
+
};
|
|
830
|
+
inflation: {
|
|
831
|
+
/** @enum {string|null} */
|
|
832
|
+
direction: "up" | "down" | "flat" | null;
|
|
833
|
+
signals: components["schemas"]["RegimeSignal"][];
|
|
834
|
+
};
|
|
835
|
+
cross_asset: {
|
|
836
|
+
dy_vs_selic_spread: number | null;
|
|
837
|
+
equity_risk_premium: number | null;
|
|
838
|
+
real_selic: number | null;
|
|
839
|
+
};
|
|
840
|
+
};
|
|
841
|
+
Expectation: {
|
|
842
|
+
survey_date: string;
|
|
843
|
+
reference: string;
|
|
844
|
+
median: number | null;
|
|
845
|
+
mean: number | null;
|
|
846
|
+
std_dev: number | null;
|
|
847
|
+
respondents: number | null;
|
|
848
|
+
base: number | null;
|
|
849
|
+
};
|
|
850
|
+
TesouroBondQuote: {
|
|
851
|
+
type: string | null;
|
|
852
|
+
name: string | null;
|
|
853
|
+
maturity: string | null;
|
|
854
|
+
date: string | null;
|
|
855
|
+
buy_rate: number | null;
|
|
856
|
+
sell_rate: number | null;
|
|
857
|
+
buy_price: number | null;
|
|
858
|
+
sell_price: number | null;
|
|
859
|
+
};
|
|
860
|
+
IndexMeta: {
|
|
861
|
+
code: string;
|
|
862
|
+
name: string;
|
|
863
|
+
rebalancing: string;
|
|
864
|
+
};
|
|
865
|
+
IndexComposition: {
|
|
866
|
+
code: string;
|
|
867
|
+
effective_date: string;
|
|
868
|
+
components: {
|
|
869
|
+
ticker: string;
|
|
870
|
+
weight: number;
|
|
871
|
+
theoretical_quantity: number;
|
|
872
|
+
}[];
|
|
873
|
+
};
|
|
874
|
+
SeriesMeta: {
|
|
875
|
+
source: string;
|
|
876
|
+
series_id: string;
|
|
877
|
+
name: string | null;
|
|
878
|
+
label: string | null;
|
|
879
|
+
unit: string | null;
|
|
880
|
+
frequency: string | null;
|
|
881
|
+
first_date: string | null;
|
|
882
|
+
last_date: string | null;
|
|
883
|
+
};
|
|
884
|
+
Fii: {
|
|
885
|
+
ticker: string;
|
|
886
|
+
cnpj: string | null;
|
|
887
|
+
name: string | null;
|
|
888
|
+
segment: string | null;
|
|
889
|
+
administrator: string | null;
|
|
890
|
+
manager: string | null;
|
|
891
|
+
is_paper: boolean;
|
|
892
|
+
};
|
|
893
|
+
FiiDistribution: {
|
|
894
|
+
ex_date: string | null;
|
|
895
|
+
payment_date: string | null;
|
|
896
|
+
value_per_share: number | null;
|
|
897
|
+
tax_free: boolean;
|
|
898
|
+
};
|
|
899
|
+
FiiMonthlyReport: {
|
|
900
|
+
reference_month: string | null;
|
|
901
|
+
net_asset_value: number | null;
|
|
902
|
+
value_per_share: number | null;
|
|
903
|
+
monthly_dividend_yield_pct: number | null;
|
|
904
|
+
shareholders: number | null;
|
|
905
|
+
shares_issued: number | null;
|
|
906
|
+
};
|
|
907
|
+
BdrProfile: {
|
|
908
|
+
ticker: string;
|
|
909
|
+
name: string | null;
|
|
910
|
+
isin: string | null;
|
|
911
|
+
/** @description patrocinado | nao_patrocinado */
|
|
912
|
+
kind: string | null;
|
|
913
|
+
spec: string | null;
|
|
914
|
+
first_traded: string | null;
|
|
915
|
+
last_traded: string | null;
|
|
916
|
+
sessions: number | null;
|
|
917
|
+
};
|
|
918
|
+
BdrQuote: {
|
|
919
|
+
date: string;
|
|
920
|
+
open: number | null;
|
|
921
|
+
high: number | null;
|
|
922
|
+
low: number | null;
|
|
923
|
+
close: number | null;
|
|
924
|
+
close_raw: number | null;
|
|
925
|
+
volume: number | null;
|
|
926
|
+
adjust_quality: string | null;
|
|
927
|
+
};
|
|
928
|
+
OptionsChain: {
|
|
929
|
+
underlying_ticker: string;
|
|
930
|
+
date: string | null;
|
|
931
|
+
count: number;
|
|
932
|
+
options: components["schemas"]["OptionContract"][];
|
|
933
|
+
};
|
|
934
|
+
OptionContract: {
|
|
935
|
+
option_ticker: string;
|
|
936
|
+
underlying_ticker: string | null;
|
|
937
|
+
underlying_root: string | null;
|
|
938
|
+
/** @description call | put */
|
|
939
|
+
option_type: string | null;
|
|
940
|
+
strike: number | null;
|
|
941
|
+
expiry: string | null;
|
|
942
|
+
date: string | null;
|
|
943
|
+
last: number | null;
|
|
944
|
+
volume_brl: number | null;
|
|
945
|
+
trades: number | null;
|
|
946
|
+
underlying_spot: number | null;
|
|
947
|
+
days_to_expiry: number | null;
|
|
948
|
+
/** @description spot / strike */
|
|
949
|
+
moneyness: number | null;
|
|
950
|
+
intrinsic: number | null;
|
|
951
|
+
time_value: number | null;
|
|
952
|
+
/** @description vol implícita anualizada (Black-Scholes europeu) */
|
|
953
|
+
iv: number | null;
|
|
954
|
+
delta: number | null;
|
|
955
|
+
gamma: number | null;
|
|
956
|
+
/** @description por 1% de vol */
|
|
957
|
+
vega: number | null;
|
|
958
|
+
/** @description por dia corrido */
|
|
959
|
+
theta: number | null;
|
|
960
|
+
/** @description IV americana (binomial CRR) — corrige exercício antecipado; relevante em puts */
|
|
961
|
+
iv_amer: number | null;
|
|
962
|
+
delta_amer: number | null;
|
|
963
|
+
gamma_amer: number | null;
|
|
964
|
+
/** @description por 1% de vol */
|
|
965
|
+
vega_amer: number | null;
|
|
966
|
+
/** @description por dia corrido */
|
|
967
|
+
theta_amer: number | null;
|
|
968
|
+
/** @description prêmio de exercício antecipado: preço americano − europeu (mesmo σ) */
|
|
969
|
+
early_ex_premium: number | null;
|
|
970
|
+
};
|
|
971
|
+
OptionExpiries: {
|
|
972
|
+
underlying_ticker: string;
|
|
973
|
+
expiries: {
|
|
974
|
+
expiry: string;
|
|
975
|
+
count: number;
|
|
976
|
+
}[];
|
|
977
|
+
};
|
|
978
|
+
OptionQuote: {
|
|
979
|
+
date: string;
|
|
980
|
+
option_ticker: string;
|
|
981
|
+
option_type: string | null;
|
|
982
|
+
strike: number | null;
|
|
983
|
+
expiry: string | null;
|
|
984
|
+
open: number | null;
|
|
985
|
+
high: number | null;
|
|
986
|
+
low: number | null;
|
|
987
|
+
last: number | null;
|
|
988
|
+
volume_brl: number | null;
|
|
989
|
+
trades: number | null;
|
|
990
|
+
underlying_spot: number | null;
|
|
991
|
+
moneyness: number | null;
|
|
992
|
+
intrinsic: number | null;
|
|
993
|
+
time_value: number | null;
|
|
994
|
+
iv: number | null;
|
|
995
|
+
delta: number | null;
|
|
996
|
+
gamma: number | null;
|
|
997
|
+
vega: number | null;
|
|
998
|
+
theta: number | null;
|
|
999
|
+
};
|
|
1000
|
+
CryptoCandle: {
|
|
1001
|
+
open_time: string;
|
|
1002
|
+
close_time: string;
|
|
1003
|
+
open: number | null;
|
|
1004
|
+
high: number | null;
|
|
1005
|
+
low: number | null;
|
|
1006
|
+
close: number | null;
|
|
1007
|
+
/** @description Volume na moeda base */
|
|
1008
|
+
volume: number | null;
|
|
1009
|
+
/** @description Volume em BRL */
|
|
1010
|
+
quote_volume: number | null;
|
|
1011
|
+
trades: number | null;
|
|
1012
|
+
};
|
|
1013
|
+
SearchResult: {
|
|
1014
|
+
/** @enum {string} */
|
|
1015
|
+
kind: "stock" | "fii" | "index" | "bond" | "macro";
|
|
1016
|
+
ticker: string;
|
|
1017
|
+
title: string;
|
|
1018
|
+
subtitle: string | null;
|
|
1019
|
+
href: string;
|
|
1020
|
+
score: number;
|
|
1021
|
+
};
|
|
1022
|
+
IngestRunSummary: {
|
|
1023
|
+
run_id: string;
|
|
1024
|
+
trigger: string;
|
|
1025
|
+
started_at: string;
|
|
1026
|
+
finished_at: string;
|
|
1027
|
+
duration_s: number;
|
|
1028
|
+
exit: number;
|
|
1029
|
+
ok: boolean;
|
|
1030
|
+
error_count: number;
|
|
1031
|
+
};
|
|
1032
|
+
IngestSourceHealth: {
|
|
1033
|
+
source: string;
|
|
1034
|
+
/** @enum {string} */
|
|
1035
|
+
status: "ok" | "stale" | "error" | "no_data";
|
|
1036
|
+
last_fetch: string | null;
|
|
1037
|
+
age_days: number | null;
|
|
1038
|
+
datasets: number;
|
|
1039
|
+
missing: number;
|
|
1040
|
+
failed_validation: number;
|
|
1041
|
+
ok: number;
|
|
1042
|
+
skip: number;
|
|
1043
|
+
miss: number;
|
|
1044
|
+
err: number;
|
|
1045
|
+
rows: number;
|
|
1046
|
+
duration_s: number | null;
|
|
1047
|
+
};
|
|
1048
|
+
};
|
|
1049
|
+
responses: never;
|
|
1050
|
+
parameters: never;
|
|
1051
|
+
requestBodies: never;
|
|
1052
|
+
headers: never;
|
|
1053
|
+
pathItems: never;
|
|
1054
|
+
}
|
|
1055
|
+
export type $defs = Record<string, never>;
|
|
1056
|
+
export interface operations {
|
|
1057
|
+
getHealth: {
|
|
1058
|
+
parameters: {
|
|
1059
|
+
query?: never;
|
|
1060
|
+
header?: never;
|
|
1061
|
+
path?: never;
|
|
1062
|
+
cookie?: never;
|
|
1063
|
+
};
|
|
1064
|
+
requestBody?: never;
|
|
1065
|
+
responses: {
|
|
1066
|
+
/** @description Status */
|
|
1067
|
+
200: {
|
|
1068
|
+
headers: {
|
|
1069
|
+
[name: string]: unknown;
|
|
1070
|
+
};
|
|
1071
|
+
content: {
|
|
1072
|
+
"application/json": components["schemas"]["Health"];
|
|
1073
|
+
};
|
|
1074
|
+
};
|
|
1075
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
1076
|
+
default: {
|
|
1077
|
+
headers: {
|
|
1078
|
+
[name: string]: unknown;
|
|
1079
|
+
};
|
|
1080
|
+
content: {
|
|
1081
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
1082
|
+
};
|
|
1083
|
+
};
|
|
1084
|
+
};
|
|
1085
|
+
};
|
|
1086
|
+
listCompanies: {
|
|
1087
|
+
parameters: {
|
|
1088
|
+
query?: {
|
|
1089
|
+
cursor?: string;
|
|
1090
|
+
limit?: number;
|
|
1091
|
+
sector?: string;
|
|
1092
|
+
segment?: string;
|
|
1093
|
+
search?: string;
|
|
1094
|
+
};
|
|
1095
|
+
header?: never;
|
|
1096
|
+
path?: never;
|
|
1097
|
+
cookie?: never;
|
|
1098
|
+
};
|
|
1099
|
+
requestBody?: never;
|
|
1100
|
+
responses: {
|
|
1101
|
+
/** @description Página de companhias */
|
|
1102
|
+
200: {
|
|
1103
|
+
headers: {
|
|
1104
|
+
[name: string]: unknown;
|
|
1105
|
+
};
|
|
1106
|
+
content: {
|
|
1107
|
+
"application/json": {
|
|
1108
|
+
data: components["schemas"]["Company"][];
|
|
1109
|
+
meta: {
|
|
1110
|
+
next_cursor: string | null;
|
|
1111
|
+
/** @description Itens nesta página */
|
|
1112
|
+
count: number;
|
|
1113
|
+
};
|
|
1114
|
+
};
|
|
1115
|
+
};
|
|
1116
|
+
};
|
|
1117
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
1118
|
+
default: {
|
|
1119
|
+
headers: {
|
|
1120
|
+
[name: string]: unknown;
|
|
1121
|
+
};
|
|
1122
|
+
content: {
|
|
1123
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
1124
|
+
};
|
|
1125
|
+
};
|
|
1126
|
+
};
|
|
1127
|
+
};
|
|
1128
|
+
getCompany: {
|
|
1129
|
+
parameters: {
|
|
1130
|
+
query?: never;
|
|
1131
|
+
header?: never;
|
|
1132
|
+
path: {
|
|
1133
|
+
cvm_code: number;
|
|
1134
|
+
};
|
|
1135
|
+
cookie?: never;
|
|
1136
|
+
};
|
|
1137
|
+
requestBody?: never;
|
|
1138
|
+
responses: {
|
|
1139
|
+
/** @description Companhia */
|
|
1140
|
+
200: {
|
|
1141
|
+
headers: {
|
|
1142
|
+
[name: string]: unknown;
|
|
1143
|
+
};
|
|
1144
|
+
content: {
|
|
1145
|
+
"application/json": components["schemas"]["Company"];
|
|
1146
|
+
};
|
|
1147
|
+
};
|
|
1148
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
1149
|
+
default: {
|
|
1150
|
+
headers: {
|
|
1151
|
+
[name: string]: unknown;
|
|
1152
|
+
};
|
|
1153
|
+
content: {
|
|
1154
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
1155
|
+
};
|
|
1156
|
+
};
|
|
1157
|
+
};
|
|
1158
|
+
};
|
|
1159
|
+
listCompanyDocuments: {
|
|
1160
|
+
parameters: {
|
|
1161
|
+
query?: {
|
|
1162
|
+
cursor?: string;
|
|
1163
|
+
limit?: number;
|
|
1164
|
+
category?: string;
|
|
1165
|
+
from?: string;
|
|
1166
|
+
to?: string;
|
|
1167
|
+
};
|
|
1168
|
+
header?: never;
|
|
1169
|
+
path: {
|
|
1170
|
+
cvm_code: number;
|
|
1171
|
+
};
|
|
1172
|
+
cookie?: never;
|
|
1173
|
+
};
|
|
1174
|
+
requestBody?: never;
|
|
1175
|
+
responses: {
|
|
1176
|
+
/** @description Página de documentos */
|
|
1177
|
+
200: {
|
|
1178
|
+
headers: {
|
|
1179
|
+
[name: string]: unknown;
|
|
1180
|
+
};
|
|
1181
|
+
content: {
|
|
1182
|
+
"application/json": {
|
|
1183
|
+
data: components["schemas"]["Document"][];
|
|
1184
|
+
meta: {
|
|
1185
|
+
next_cursor: string | null;
|
|
1186
|
+
/** @description Itens nesta página */
|
|
1187
|
+
count: number;
|
|
1188
|
+
};
|
|
1189
|
+
};
|
|
1190
|
+
};
|
|
1191
|
+
};
|
|
1192
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
1193
|
+
default: {
|
|
1194
|
+
headers: {
|
|
1195
|
+
[name: string]: unknown;
|
|
1196
|
+
};
|
|
1197
|
+
content: {
|
|
1198
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
1199
|
+
};
|
|
1200
|
+
};
|
|
1201
|
+
};
|
|
1202
|
+
};
|
|
1203
|
+
getStock: {
|
|
1204
|
+
parameters: {
|
|
1205
|
+
query?: never;
|
|
1206
|
+
header?: never;
|
|
1207
|
+
path: {
|
|
1208
|
+
ticker: string;
|
|
1209
|
+
};
|
|
1210
|
+
cookie?: never;
|
|
1211
|
+
};
|
|
1212
|
+
requestBody?: never;
|
|
1213
|
+
responses: {
|
|
1214
|
+
/** @description Ação */
|
|
1215
|
+
200: {
|
|
1216
|
+
headers: {
|
|
1217
|
+
[name: string]: unknown;
|
|
1218
|
+
};
|
|
1219
|
+
content: {
|
|
1220
|
+
"application/json": components["schemas"]["Stock"];
|
|
1221
|
+
};
|
|
1222
|
+
};
|
|
1223
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
1224
|
+
default: {
|
|
1225
|
+
headers: {
|
|
1226
|
+
[name: string]: unknown;
|
|
1227
|
+
};
|
|
1228
|
+
content: {
|
|
1229
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
1230
|
+
};
|
|
1231
|
+
};
|
|
1232
|
+
};
|
|
1233
|
+
};
|
|
1234
|
+
listQuotes: {
|
|
1235
|
+
parameters: {
|
|
1236
|
+
query?: {
|
|
1237
|
+
cursor?: string;
|
|
1238
|
+
limit?: number;
|
|
1239
|
+
from?: string;
|
|
1240
|
+
to?: string;
|
|
1241
|
+
adjusted?: string;
|
|
1242
|
+
};
|
|
1243
|
+
header?: never;
|
|
1244
|
+
path: {
|
|
1245
|
+
ticker: string;
|
|
1246
|
+
};
|
|
1247
|
+
cookie?: never;
|
|
1248
|
+
};
|
|
1249
|
+
requestBody?: never;
|
|
1250
|
+
responses: {
|
|
1251
|
+
/** @description Página de cotações */
|
|
1252
|
+
200: {
|
|
1253
|
+
headers: {
|
|
1254
|
+
[name: string]: unknown;
|
|
1255
|
+
};
|
|
1256
|
+
content: {
|
|
1257
|
+
"application/json": {
|
|
1258
|
+
data: components["schemas"]["Quote"][];
|
|
1259
|
+
meta: {
|
|
1260
|
+
next_cursor: string | null;
|
|
1261
|
+
/** @description Itens nesta página */
|
|
1262
|
+
count: number;
|
|
1263
|
+
};
|
|
1264
|
+
};
|
|
1265
|
+
};
|
|
1266
|
+
};
|
|
1267
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
1268
|
+
default: {
|
|
1269
|
+
headers: {
|
|
1270
|
+
[name: string]: unknown;
|
|
1271
|
+
};
|
|
1272
|
+
content: {
|
|
1273
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
1274
|
+
};
|
|
1275
|
+
};
|
|
1276
|
+
};
|
|
1277
|
+
};
|
|
1278
|
+
getStockIndicators: {
|
|
1279
|
+
parameters: {
|
|
1280
|
+
query?: {
|
|
1281
|
+
names?: string;
|
|
1282
|
+
at?: string;
|
|
1283
|
+
};
|
|
1284
|
+
header?: never;
|
|
1285
|
+
path: {
|
|
1286
|
+
ticker: string;
|
|
1287
|
+
};
|
|
1288
|
+
cookie?: never;
|
|
1289
|
+
};
|
|
1290
|
+
requestBody?: never;
|
|
1291
|
+
responses: {
|
|
1292
|
+
/** @description Indicadores do papel */
|
|
1293
|
+
200: {
|
|
1294
|
+
headers: {
|
|
1295
|
+
[name: string]: unknown;
|
|
1296
|
+
};
|
|
1297
|
+
content: {
|
|
1298
|
+
"application/json": {
|
|
1299
|
+
ticker: string;
|
|
1300
|
+
reference_date: string;
|
|
1301
|
+
is_financial: boolean;
|
|
1302
|
+
indicators: components["schemas"]["IndicatorValue"][];
|
|
1303
|
+
};
|
|
1304
|
+
};
|
|
1305
|
+
};
|
|
1306
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
1307
|
+
default: {
|
|
1308
|
+
headers: {
|
|
1309
|
+
[name: string]: unknown;
|
|
1310
|
+
};
|
|
1311
|
+
content: {
|
|
1312
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
1313
|
+
};
|
|
1314
|
+
};
|
|
1315
|
+
};
|
|
1316
|
+
};
|
|
1317
|
+
getStockIndicatorHistory: {
|
|
1318
|
+
parameters: {
|
|
1319
|
+
query: {
|
|
1320
|
+
name: string;
|
|
1321
|
+
from?: string;
|
|
1322
|
+
to?: string;
|
|
1323
|
+
};
|
|
1324
|
+
header?: never;
|
|
1325
|
+
path: {
|
|
1326
|
+
ticker: string;
|
|
1327
|
+
};
|
|
1328
|
+
cookie?: never;
|
|
1329
|
+
};
|
|
1330
|
+
requestBody?: never;
|
|
1331
|
+
responses: {
|
|
1332
|
+
/** @description Série do indicador */
|
|
1333
|
+
200: {
|
|
1334
|
+
headers: {
|
|
1335
|
+
[name: string]: unknown;
|
|
1336
|
+
};
|
|
1337
|
+
content: {
|
|
1338
|
+
"application/json": {
|
|
1339
|
+
ticker: string;
|
|
1340
|
+
name: string;
|
|
1341
|
+
label: string;
|
|
1342
|
+
/** @enum {string} */
|
|
1343
|
+
unit: "ratio" | "percent" | "brl" | "brl_per_share" | "count" | "days";
|
|
1344
|
+
observations: components["schemas"]["Observation"][];
|
|
1345
|
+
};
|
|
1346
|
+
};
|
|
1347
|
+
};
|
|
1348
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
1349
|
+
default: {
|
|
1350
|
+
headers: {
|
|
1351
|
+
[name: string]: unknown;
|
|
1352
|
+
};
|
|
1353
|
+
content: {
|
|
1354
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
1355
|
+
};
|
|
1356
|
+
};
|
|
1357
|
+
};
|
|
1358
|
+
};
|
|
1359
|
+
listDividends: {
|
|
1360
|
+
parameters: {
|
|
1361
|
+
query?: {
|
|
1362
|
+
cursor?: string;
|
|
1363
|
+
limit?: number;
|
|
1364
|
+
from?: string;
|
|
1365
|
+
to?: string;
|
|
1366
|
+
};
|
|
1367
|
+
header?: never;
|
|
1368
|
+
path: {
|
|
1369
|
+
ticker: string;
|
|
1370
|
+
};
|
|
1371
|
+
cookie?: never;
|
|
1372
|
+
};
|
|
1373
|
+
requestBody?: never;
|
|
1374
|
+
responses: {
|
|
1375
|
+
/** @description Página de proventos */
|
|
1376
|
+
200: {
|
|
1377
|
+
headers: {
|
|
1378
|
+
[name: string]: unknown;
|
|
1379
|
+
};
|
|
1380
|
+
content: {
|
|
1381
|
+
"application/json": {
|
|
1382
|
+
data: components["schemas"]["Dividend"][];
|
|
1383
|
+
meta: {
|
|
1384
|
+
next_cursor: string | null;
|
|
1385
|
+
/** @description Itens nesta página */
|
|
1386
|
+
count: number;
|
|
1387
|
+
};
|
|
1388
|
+
};
|
|
1389
|
+
};
|
|
1390
|
+
};
|
|
1391
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
1392
|
+
default: {
|
|
1393
|
+
headers: {
|
|
1394
|
+
[name: string]: unknown;
|
|
1395
|
+
};
|
|
1396
|
+
content: {
|
|
1397
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
1398
|
+
};
|
|
1399
|
+
};
|
|
1400
|
+
};
|
|
1401
|
+
};
|
|
1402
|
+
listCorporateEvents: {
|
|
1403
|
+
parameters: {
|
|
1404
|
+
query?: {
|
|
1405
|
+
from?: string;
|
|
1406
|
+
to?: string;
|
|
1407
|
+
};
|
|
1408
|
+
header?: never;
|
|
1409
|
+
path: {
|
|
1410
|
+
ticker: string;
|
|
1411
|
+
};
|
|
1412
|
+
cookie?: never;
|
|
1413
|
+
};
|
|
1414
|
+
requestBody?: never;
|
|
1415
|
+
responses: {
|
|
1416
|
+
/** @description Lista de eventos */
|
|
1417
|
+
200: {
|
|
1418
|
+
headers: {
|
|
1419
|
+
[name: string]: unknown;
|
|
1420
|
+
};
|
|
1421
|
+
content: {
|
|
1422
|
+
"application/json": components["schemas"]["CorporateEvent"][];
|
|
1423
|
+
};
|
|
1424
|
+
};
|
|
1425
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
1426
|
+
default: {
|
|
1427
|
+
headers: {
|
|
1428
|
+
[name: string]: unknown;
|
|
1429
|
+
};
|
|
1430
|
+
content: {
|
|
1431
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
1432
|
+
};
|
|
1433
|
+
};
|
|
1434
|
+
};
|
|
1435
|
+
};
|
|
1436
|
+
listInsiderMoves: {
|
|
1437
|
+
parameters: {
|
|
1438
|
+
query?: {
|
|
1439
|
+
from?: string;
|
|
1440
|
+
to?: string;
|
|
1441
|
+
};
|
|
1442
|
+
header?: never;
|
|
1443
|
+
path: {
|
|
1444
|
+
ticker: string;
|
|
1445
|
+
};
|
|
1446
|
+
cookie?: never;
|
|
1447
|
+
};
|
|
1448
|
+
requestBody?: never;
|
|
1449
|
+
responses: {
|
|
1450
|
+
/** @description Saldo mensal de insiders */
|
|
1451
|
+
200: {
|
|
1452
|
+
headers: {
|
|
1453
|
+
[name: string]: unknown;
|
|
1454
|
+
};
|
|
1455
|
+
content: {
|
|
1456
|
+
"application/json": {
|
|
1457
|
+
ticker: string;
|
|
1458
|
+
data: components["schemas"]["InsiderMove"][];
|
|
1459
|
+
};
|
|
1460
|
+
};
|
|
1461
|
+
};
|
|
1462
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
1463
|
+
default: {
|
|
1464
|
+
headers: {
|
|
1465
|
+
[name: string]: unknown;
|
|
1466
|
+
};
|
|
1467
|
+
content: {
|
|
1468
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
1469
|
+
};
|
|
1470
|
+
};
|
|
1471
|
+
};
|
|
1472
|
+
};
|
|
1473
|
+
screenStocks: {
|
|
1474
|
+
parameters: {
|
|
1475
|
+
query?: {
|
|
1476
|
+
cursor?: string;
|
|
1477
|
+
limit?: number;
|
|
1478
|
+
pl_min?: number;
|
|
1479
|
+
pl_max?: number;
|
|
1480
|
+
pvp_min?: number;
|
|
1481
|
+
pvp_max?: number;
|
|
1482
|
+
dy_min?: number;
|
|
1483
|
+
roe_min?: number;
|
|
1484
|
+
ev_ebitda_max?: number;
|
|
1485
|
+
div_liq_ebitda_max?: number;
|
|
1486
|
+
sector?: string;
|
|
1487
|
+
segment?: string;
|
|
1488
|
+
sort?: string;
|
|
1489
|
+
};
|
|
1490
|
+
header?: never;
|
|
1491
|
+
path?: never;
|
|
1492
|
+
cookie?: never;
|
|
1493
|
+
};
|
|
1494
|
+
requestBody?: never;
|
|
1495
|
+
responses: {
|
|
1496
|
+
/** @description Página de resultados */
|
|
1497
|
+
200: {
|
|
1498
|
+
headers: {
|
|
1499
|
+
[name: string]: unknown;
|
|
1500
|
+
};
|
|
1501
|
+
content: {
|
|
1502
|
+
"application/json": {
|
|
1503
|
+
data: components["schemas"]["ScreenerRow"][];
|
|
1504
|
+
meta: {
|
|
1505
|
+
next_cursor: string | null;
|
|
1506
|
+
/** @description Itens nesta página */
|
|
1507
|
+
count: number;
|
|
1508
|
+
};
|
|
1509
|
+
};
|
|
1510
|
+
};
|
|
1511
|
+
};
|
|
1512
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
1513
|
+
default: {
|
|
1514
|
+
headers: {
|
|
1515
|
+
[name: string]: unknown;
|
|
1516
|
+
};
|
|
1517
|
+
content: {
|
|
1518
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
1519
|
+
};
|
|
1520
|
+
};
|
|
1521
|
+
};
|
|
1522
|
+
};
|
|
1523
|
+
screenFiis: {
|
|
1524
|
+
parameters: {
|
|
1525
|
+
query?: {
|
|
1526
|
+
cursor?: string;
|
|
1527
|
+
limit?: number;
|
|
1528
|
+
segment?: string;
|
|
1529
|
+
paper?: "true" | "false";
|
|
1530
|
+
sort?: string;
|
|
1531
|
+
};
|
|
1532
|
+
header?: never;
|
|
1533
|
+
path?: never;
|
|
1534
|
+
cookie?: never;
|
|
1535
|
+
};
|
|
1536
|
+
requestBody?: never;
|
|
1537
|
+
responses: {
|
|
1538
|
+
/** @description Página de FIIs */
|
|
1539
|
+
200: {
|
|
1540
|
+
headers: {
|
|
1541
|
+
[name: string]: unknown;
|
|
1542
|
+
};
|
|
1543
|
+
content: {
|
|
1544
|
+
"application/json": {
|
|
1545
|
+
data: components["schemas"]["FiiListRow"][];
|
|
1546
|
+
meta: {
|
|
1547
|
+
next_cursor: string | null;
|
|
1548
|
+
/** @description Itens nesta página */
|
|
1549
|
+
count: number;
|
|
1550
|
+
};
|
|
1551
|
+
};
|
|
1552
|
+
};
|
|
1553
|
+
};
|
|
1554
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
1555
|
+
default: {
|
|
1556
|
+
headers: {
|
|
1557
|
+
[name: string]: unknown;
|
|
1558
|
+
};
|
|
1559
|
+
content: {
|
|
1560
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
1561
|
+
};
|
|
1562
|
+
};
|
|
1563
|
+
};
|
|
1564
|
+
};
|
|
1565
|
+
getMacroGears: {
|
|
1566
|
+
parameters: {
|
|
1567
|
+
query?: {
|
|
1568
|
+
gear?: "monetary" | "inflation" | "growth" | "employment" | "credit" | "fiscal" | "external" | "sovereign_risk" | "global" | "currency" | "cross_asset";
|
|
1569
|
+
at?: string;
|
|
1570
|
+
};
|
|
1571
|
+
header?: never;
|
|
1572
|
+
path?: never;
|
|
1573
|
+
cookie?: never;
|
|
1574
|
+
};
|
|
1575
|
+
requestBody?: never;
|
|
1576
|
+
responses: {
|
|
1577
|
+
/** @description Sinais por engrenagem */
|
|
1578
|
+
200: {
|
|
1579
|
+
headers: {
|
|
1580
|
+
[name: string]: unknown;
|
|
1581
|
+
};
|
|
1582
|
+
content: {
|
|
1583
|
+
"application/json": {
|
|
1584
|
+
as_of: string | null;
|
|
1585
|
+
gears: {
|
|
1586
|
+
gear: string;
|
|
1587
|
+
indicators: components["schemas"]["RegimeSignal"][];
|
|
1588
|
+
}[];
|
|
1589
|
+
};
|
|
1590
|
+
};
|
|
1591
|
+
};
|
|
1592
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
1593
|
+
default: {
|
|
1594
|
+
headers: {
|
|
1595
|
+
[name: string]: unknown;
|
|
1596
|
+
};
|
|
1597
|
+
content: {
|
|
1598
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
1599
|
+
};
|
|
1600
|
+
};
|
|
1601
|
+
};
|
|
1602
|
+
};
|
|
1603
|
+
getMacroRegime: {
|
|
1604
|
+
parameters: {
|
|
1605
|
+
query?: {
|
|
1606
|
+
at?: string;
|
|
1607
|
+
};
|
|
1608
|
+
header?: never;
|
|
1609
|
+
path?: never;
|
|
1610
|
+
cookie?: never;
|
|
1611
|
+
};
|
|
1612
|
+
requestBody?: never;
|
|
1613
|
+
responses: {
|
|
1614
|
+
/** @description Snapshot do regime */
|
|
1615
|
+
200: {
|
|
1616
|
+
headers: {
|
|
1617
|
+
[name: string]: unknown;
|
|
1618
|
+
};
|
|
1619
|
+
content: {
|
|
1620
|
+
"application/json": components["schemas"]["RegimeSnapshot"];
|
|
1621
|
+
};
|
|
1622
|
+
};
|
|
1623
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
1624
|
+
default: {
|
|
1625
|
+
headers: {
|
|
1626
|
+
[name: string]: unknown;
|
|
1627
|
+
};
|
|
1628
|
+
content: {
|
|
1629
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
1630
|
+
};
|
|
1631
|
+
};
|
|
1632
|
+
};
|
|
1633
|
+
};
|
|
1634
|
+
getMarketExpectations: {
|
|
1635
|
+
parameters: {
|
|
1636
|
+
query: {
|
|
1637
|
+
indicator: "ipca" | "selic" | "pib" | "cambio";
|
|
1638
|
+
reference?: string;
|
|
1639
|
+
from?: string;
|
|
1640
|
+
to?: string;
|
|
1641
|
+
};
|
|
1642
|
+
header?: never;
|
|
1643
|
+
path?: never;
|
|
1644
|
+
cookie?: never;
|
|
1645
|
+
};
|
|
1646
|
+
requestBody?: never;
|
|
1647
|
+
responses: {
|
|
1648
|
+
/** @description Expectativas */
|
|
1649
|
+
200: {
|
|
1650
|
+
headers: {
|
|
1651
|
+
[name: string]: unknown;
|
|
1652
|
+
};
|
|
1653
|
+
content: {
|
|
1654
|
+
"application/json": {
|
|
1655
|
+
indicator: string;
|
|
1656
|
+
reference: string | null;
|
|
1657
|
+
realized: number | null;
|
|
1658
|
+
surveys: components["schemas"]["Expectation"][];
|
|
1659
|
+
};
|
|
1660
|
+
};
|
|
1661
|
+
};
|
|
1662
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
1663
|
+
default: {
|
|
1664
|
+
headers: {
|
|
1665
|
+
[name: string]: unknown;
|
|
1666
|
+
};
|
|
1667
|
+
content: {
|
|
1668
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
1669
|
+
};
|
|
1670
|
+
};
|
|
1671
|
+
};
|
|
1672
|
+
};
|
|
1673
|
+
getYieldCurve: {
|
|
1674
|
+
parameters: {
|
|
1675
|
+
query?: {
|
|
1676
|
+
date?: string;
|
|
1677
|
+
kind?: "nominal" | "real";
|
|
1678
|
+
};
|
|
1679
|
+
header?: never;
|
|
1680
|
+
path?: never;
|
|
1681
|
+
cookie?: never;
|
|
1682
|
+
};
|
|
1683
|
+
requestBody?: never;
|
|
1684
|
+
responses: {
|
|
1685
|
+
/** @description Curva de juros */
|
|
1686
|
+
200: {
|
|
1687
|
+
headers: {
|
|
1688
|
+
[name: string]: unknown;
|
|
1689
|
+
};
|
|
1690
|
+
content: {
|
|
1691
|
+
"application/json": {
|
|
1692
|
+
date: string | null;
|
|
1693
|
+
/** @enum {string} */
|
|
1694
|
+
kind: "nominal" | "real";
|
|
1695
|
+
points: {
|
|
1696
|
+
maturity: string;
|
|
1697
|
+
years: number | null;
|
|
1698
|
+
rate: number;
|
|
1699
|
+
}[];
|
|
1700
|
+
};
|
|
1701
|
+
};
|
|
1702
|
+
};
|
|
1703
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
1704
|
+
default: {
|
|
1705
|
+
headers: {
|
|
1706
|
+
[name: string]: unknown;
|
|
1707
|
+
};
|
|
1708
|
+
content: {
|
|
1709
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
1710
|
+
};
|
|
1711
|
+
};
|
|
1712
|
+
};
|
|
1713
|
+
};
|
|
1714
|
+
listTesouroBonds: {
|
|
1715
|
+
parameters: {
|
|
1716
|
+
query?: {
|
|
1717
|
+
cursor?: string;
|
|
1718
|
+
limit?: number;
|
|
1719
|
+
type?: "LTN" | "NTN-F" | "NTN-B" | "NTN-B-Principal" | "LFT" | "RENDA+" | "EDUCA+";
|
|
1720
|
+
maturity?: string;
|
|
1721
|
+
date?: string;
|
|
1722
|
+
};
|
|
1723
|
+
header?: never;
|
|
1724
|
+
path?: never;
|
|
1725
|
+
cookie?: never;
|
|
1726
|
+
};
|
|
1727
|
+
requestBody?: never;
|
|
1728
|
+
responses: {
|
|
1729
|
+
/** @description Página de títulos */
|
|
1730
|
+
200: {
|
|
1731
|
+
headers: {
|
|
1732
|
+
[name: string]: unknown;
|
|
1733
|
+
};
|
|
1734
|
+
content: {
|
|
1735
|
+
"application/json": {
|
|
1736
|
+
data: components["schemas"]["TesouroBondQuote"][];
|
|
1737
|
+
meta: {
|
|
1738
|
+
next_cursor: string | null;
|
|
1739
|
+
/** @description Itens nesta página */
|
|
1740
|
+
count: number;
|
|
1741
|
+
};
|
|
1742
|
+
};
|
|
1743
|
+
};
|
|
1744
|
+
};
|
|
1745
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
1746
|
+
default: {
|
|
1747
|
+
headers: {
|
|
1748
|
+
[name: string]: unknown;
|
|
1749
|
+
};
|
|
1750
|
+
content: {
|
|
1751
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
1752
|
+
};
|
|
1753
|
+
};
|
|
1754
|
+
};
|
|
1755
|
+
};
|
|
1756
|
+
listIndices: {
|
|
1757
|
+
parameters: {
|
|
1758
|
+
query?: never;
|
|
1759
|
+
header?: never;
|
|
1760
|
+
path?: never;
|
|
1761
|
+
cookie?: never;
|
|
1762
|
+
};
|
|
1763
|
+
requestBody?: never;
|
|
1764
|
+
responses: {
|
|
1765
|
+
/** @description Lista de índices */
|
|
1766
|
+
200: {
|
|
1767
|
+
headers: {
|
|
1768
|
+
[name: string]: unknown;
|
|
1769
|
+
};
|
|
1770
|
+
content: {
|
|
1771
|
+
"application/json": components["schemas"]["IndexMeta"][];
|
|
1772
|
+
};
|
|
1773
|
+
};
|
|
1774
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
1775
|
+
default: {
|
|
1776
|
+
headers: {
|
|
1777
|
+
[name: string]: unknown;
|
|
1778
|
+
};
|
|
1779
|
+
content: {
|
|
1780
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
1781
|
+
};
|
|
1782
|
+
};
|
|
1783
|
+
};
|
|
1784
|
+
};
|
|
1785
|
+
listIndexQuotes: {
|
|
1786
|
+
parameters: {
|
|
1787
|
+
query?: {
|
|
1788
|
+
cursor?: string;
|
|
1789
|
+
limit?: number;
|
|
1790
|
+
from?: string;
|
|
1791
|
+
to?: string;
|
|
1792
|
+
};
|
|
1793
|
+
header?: never;
|
|
1794
|
+
path: {
|
|
1795
|
+
code: string;
|
|
1796
|
+
};
|
|
1797
|
+
cookie?: never;
|
|
1798
|
+
};
|
|
1799
|
+
requestBody?: never;
|
|
1800
|
+
responses: {
|
|
1801
|
+
/** @description Página de níveis */
|
|
1802
|
+
200: {
|
|
1803
|
+
headers: {
|
|
1804
|
+
[name: string]: unknown;
|
|
1805
|
+
};
|
|
1806
|
+
content: {
|
|
1807
|
+
"application/json": {
|
|
1808
|
+
data: components["schemas"]["Observation"][];
|
|
1809
|
+
meta: {
|
|
1810
|
+
next_cursor: string | null;
|
|
1811
|
+
/** @description Itens nesta página */
|
|
1812
|
+
count: number;
|
|
1813
|
+
};
|
|
1814
|
+
};
|
|
1815
|
+
};
|
|
1816
|
+
};
|
|
1817
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
1818
|
+
default: {
|
|
1819
|
+
headers: {
|
|
1820
|
+
[name: string]: unknown;
|
|
1821
|
+
};
|
|
1822
|
+
content: {
|
|
1823
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
1824
|
+
};
|
|
1825
|
+
};
|
|
1826
|
+
};
|
|
1827
|
+
};
|
|
1828
|
+
getIndexComposition: {
|
|
1829
|
+
parameters: {
|
|
1830
|
+
query?: never;
|
|
1831
|
+
header?: never;
|
|
1832
|
+
path: {
|
|
1833
|
+
code: string;
|
|
1834
|
+
};
|
|
1835
|
+
cookie?: never;
|
|
1836
|
+
};
|
|
1837
|
+
requestBody?: never;
|
|
1838
|
+
responses: {
|
|
1839
|
+
/** @description Composição teórica */
|
|
1840
|
+
200: {
|
|
1841
|
+
headers: {
|
|
1842
|
+
[name: string]: unknown;
|
|
1843
|
+
};
|
|
1844
|
+
content: {
|
|
1845
|
+
"application/json": components["schemas"]["IndexComposition"];
|
|
1846
|
+
};
|
|
1847
|
+
};
|
|
1848
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
1849
|
+
default: {
|
|
1850
|
+
headers: {
|
|
1851
|
+
[name: string]: unknown;
|
|
1852
|
+
};
|
|
1853
|
+
content: {
|
|
1854
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
1855
|
+
};
|
|
1856
|
+
};
|
|
1857
|
+
};
|
|
1858
|
+
};
|
|
1859
|
+
listSeries: {
|
|
1860
|
+
parameters: {
|
|
1861
|
+
query?: {
|
|
1862
|
+
cursor?: string;
|
|
1863
|
+
limit?: number;
|
|
1864
|
+
source?: "bcb_sgs" | "bcb_focus" | "ibge_sidra" | "fred" | "ipeadata" | "tesouro_direto";
|
|
1865
|
+
search?: string;
|
|
1866
|
+
};
|
|
1867
|
+
header?: never;
|
|
1868
|
+
path?: never;
|
|
1869
|
+
cookie?: never;
|
|
1870
|
+
};
|
|
1871
|
+
requestBody?: never;
|
|
1872
|
+
responses: {
|
|
1873
|
+
/** @description Página do catálogo */
|
|
1874
|
+
200: {
|
|
1875
|
+
headers: {
|
|
1876
|
+
[name: string]: unknown;
|
|
1877
|
+
};
|
|
1878
|
+
content: {
|
|
1879
|
+
"application/json": {
|
|
1880
|
+
data: components["schemas"]["SeriesMeta"][];
|
|
1881
|
+
meta: {
|
|
1882
|
+
next_cursor: string | null;
|
|
1883
|
+
/** @description Itens nesta página */
|
|
1884
|
+
count: number;
|
|
1885
|
+
};
|
|
1886
|
+
};
|
|
1887
|
+
};
|
|
1888
|
+
};
|
|
1889
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
1890
|
+
default: {
|
|
1891
|
+
headers: {
|
|
1892
|
+
[name: string]: unknown;
|
|
1893
|
+
};
|
|
1894
|
+
content: {
|
|
1895
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
1896
|
+
};
|
|
1897
|
+
};
|
|
1898
|
+
};
|
|
1899
|
+
};
|
|
1900
|
+
getSeries: {
|
|
1901
|
+
parameters: {
|
|
1902
|
+
query?: {
|
|
1903
|
+
from?: string;
|
|
1904
|
+
to?: string;
|
|
1905
|
+
accumulated?: "none" | "12m";
|
|
1906
|
+
};
|
|
1907
|
+
header?: never;
|
|
1908
|
+
path: {
|
|
1909
|
+
source: string;
|
|
1910
|
+
series_id: string;
|
|
1911
|
+
};
|
|
1912
|
+
cookie?: never;
|
|
1913
|
+
};
|
|
1914
|
+
requestBody?: never;
|
|
1915
|
+
responses: {
|
|
1916
|
+
/** @description Série com metadados e observações */
|
|
1917
|
+
200: {
|
|
1918
|
+
headers: {
|
|
1919
|
+
[name: string]: unknown;
|
|
1920
|
+
};
|
|
1921
|
+
content: {
|
|
1922
|
+
"application/json": {
|
|
1923
|
+
meta: components["schemas"]["SeriesMeta"];
|
|
1924
|
+
observations: components["schemas"]["Observation"][];
|
|
1925
|
+
};
|
|
1926
|
+
};
|
|
1927
|
+
};
|
|
1928
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
1929
|
+
default: {
|
|
1930
|
+
headers: {
|
|
1931
|
+
[name: string]: unknown;
|
|
1932
|
+
};
|
|
1933
|
+
content: {
|
|
1934
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
1935
|
+
};
|
|
1936
|
+
};
|
|
1937
|
+
};
|
|
1938
|
+
};
|
|
1939
|
+
getFii: {
|
|
1940
|
+
parameters: {
|
|
1941
|
+
query?: never;
|
|
1942
|
+
header?: never;
|
|
1943
|
+
path: {
|
|
1944
|
+
ticker: string;
|
|
1945
|
+
};
|
|
1946
|
+
cookie?: never;
|
|
1947
|
+
};
|
|
1948
|
+
requestBody?: never;
|
|
1949
|
+
responses: {
|
|
1950
|
+
/** @description FII */
|
|
1951
|
+
200: {
|
|
1952
|
+
headers: {
|
|
1953
|
+
[name: string]: unknown;
|
|
1954
|
+
};
|
|
1955
|
+
content: {
|
|
1956
|
+
"application/json": components["schemas"]["Fii"];
|
|
1957
|
+
};
|
|
1958
|
+
};
|
|
1959
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
1960
|
+
default: {
|
|
1961
|
+
headers: {
|
|
1962
|
+
[name: string]: unknown;
|
|
1963
|
+
};
|
|
1964
|
+
content: {
|
|
1965
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
1966
|
+
};
|
|
1967
|
+
};
|
|
1968
|
+
};
|
|
1969
|
+
};
|
|
1970
|
+
getFiiIndicators: {
|
|
1971
|
+
parameters: {
|
|
1972
|
+
query?: never;
|
|
1973
|
+
header?: never;
|
|
1974
|
+
path: {
|
|
1975
|
+
ticker: string;
|
|
1976
|
+
};
|
|
1977
|
+
cookie?: never;
|
|
1978
|
+
};
|
|
1979
|
+
requestBody?: never;
|
|
1980
|
+
responses: {
|
|
1981
|
+
/** @description Indicadores do FII */
|
|
1982
|
+
200: {
|
|
1983
|
+
headers: {
|
|
1984
|
+
[name: string]: unknown;
|
|
1985
|
+
};
|
|
1986
|
+
content: {
|
|
1987
|
+
"application/json": {
|
|
1988
|
+
ticker: string;
|
|
1989
|
+
reference_date: string | null;
|
|
1990
|
+
indicators: components["schemas"]["IndicatorValue"][];
|
|
1991
|
+
};
|
|
1992
|
+
};
|
|
1993
|
+
};
|
|
1994
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
1995
|
+
default: {
|
|
1996
|
+
headers: {
|
|
1997
|
+
[name: string]: unknown;
|
|
1998
|
+
};
|
|
1999
|
+
content: {
|
|
2000
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
2001
|
+
};
|
|
2002
|
+
};
|
|
2003
|
+
};
|
|
2004
|
+
};
|
|
2005
|
+
getFiiIndicatorHistory: {
|
|
2006
|
+
parameters: {
|
|
2007
|
+
query: {
|
|
2008
|
+
name: string;
|
|
2009
|
+
from?: string;
|
|
2010
|
+
to?: string;
|
|
2011
|
+
};
|
|
2012
|
+
header?: never;
|
|
2013
|
+
path: {
|
|
2014
|
+
ticker: string;
|
|
2015
|
+
};
|
|
2016
|
+
cookie?: never;
|
|
2017
|
+
};
|
|
2018
|
+
requestBody?: never;
|
|
2019
|
+
responses: {
|
|
2020
|
+
/** @description Série do indicador */
|
|
2021
|
+
200: {
|
|
2022
|
+
headers: {
|
|
2023
|
+
[name: string]: unknown;
|
|
2024
|
+
};
|
|
2025
|
+
content: {
|
|
2026
|
+
"application/json": {
|
|
2027
|
+
ticker: string;
|
|
2028
|
+
name: string;
|
|
2029
|
+
label: string;
|
|
2030
|
+
/** @enum {string} */
|
|
2031
|
+
unit: "ratio" | "percent" | "brl" | "brl_per_share" | "count" | "days";
|
|
2032
|
+
observations: components["schemas"]["Observation"][];
|
|
2033
|
+
};
|
|
2034
|
+
};
|
|
2035
|
+
};
|
|
2036
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
2037
|
+
default: {
|
|
2038
|
+
headers: {
|
|
2039
|
+
[name: string]: unknown;
|
|
2040
|
+
};
|
|
2041
|
+
content: {
|
|
2042
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
2043
|
+
};
|
|
2044
|
+
};
|
|
2045
|
+
};
|
|
2046
|
+
};
|
|
2047
|
+
listFiiDistributions: {
|
|
2048
|
+
parameters: {
|
|
2049
|
+
query?: {
|
|
2050
|
+
cursor?: string;
|
|
2051
|
+
limit?: number;
|
|
2052
|
+
from?: string;
|
|
2053
|
+
to?: string;
|
|
2054
|
+
};
|
|
2055
|
+
header?: never;
|
|
2056
|
+
path: {
|
|
2057
|
+
ticker: string;
|
|
2058
|
+
};
|
|
2059
|
+
cookie?: never;
|
|
2060
|
+
};
|
|
2061
|
+
requestBody?: never;
|
|
2062
|
+
responses: {
|
|
2063
|
+
/** @description Página de distribuições */
|
|
2064
|
+
200: {
|
|
2065
|
+
headers: {
|
|
2066
|
+
[name: string]: unknown;
|
|
2067
|
+
};
|
|
2068
|
+
content: {
|
|
2069
|
+
"application/json": {
|
|
2070
|
+
data: components["schemas"]["FiiDistribution"][];
|
|
2071
|
+
meta: {
|
|
2072
|
+
next_cursor: string | null;
|
|
2073
|
+
/** @description Itens nesta página */
|
|
2074
|
+
count: number;
|
|
2075
|
+
};
|
|
2076
|
+
};
|
|
2077
|
+
};
|
|
2078
|
+
};
|
|
2079
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
2080
|
+
default: {
|
|
2081
|
+
headers: {
|
|
2082
|
+
[name: string]: unknown;
|
|
2083
|
+
};
|
|
2084
|
+
content: {
|
|
2085
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
2086
|
+
};
|
|
2087
|
+
};
|
|
2088
|
+
};
|
|
2089
|
+
};
|
|
2090
|
+
listFiiReports: {
|
|
2091
|
+
parameters: {
|
|
2092
|
+
query?: {
|
|
2093
|
+
cursor?: string;
|
|
2094
|
+
limit?: number;
|
|
2095
|
+
from?: string;
|
|
2096
|
+
to?: string;
|
|
2097
|
+
};
|
|
2098
|
+
header?: never;
|
|
2099
|
+
path: {
|
|
2100
|
+
ticker: string;
|
|
2101
|
+
};
|
|
2102
|
+
cookie?: never;
|
|
2103
|
+
};
|
|
2104
|
+
requestBody?: never;
|
|
2105
|
+
responses: {
|
|
2106
|
+
/** @description Página de informes */
|
|
2107
|
+
200: {
|
|
2108
|
+
headers: {
|
|
2109
|
+
[name: string]: unknown;
|
|
2110
|
+
};
|
|
2111
|
+
content: {
|
|
2112
|
+
"application/json": {
|
|
2113
|
+
data: components["schemas"]["FiiMonthlyReport"][];
|
|
2114
|
+
meta: {
|
|
2115
|
+
next_cursor: string | null;
|
|
2116
|
+
/** @description Itens nesta página */
|
|
2117
|
+
count: number;
|
|
2118
|
+
};
|
|
2119
|
+
};
|
|
2120
|
+
};
|
|
2121
|
+
};
|
|
2122
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
2123
|
+
default: {
|
|
2124
|
+
headers: {
|
|
2125
|
+
[name: string]: unknown;
|
|
2126
|
+
};
|
|
2127
|
+
content: {
|
|
2128
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
2129
|
+
};
|
|
2130
|
+
};
|
|
2131
|
+
};
|
|
2132
|
+
};
|
|
2133
|
+
listBdrs: {
|
|
2134
|
+
parameters: {
|
|
2135
|
+
query?: {
|
|
2136
|
+
cursor?: string;
|
|
2137
|
+
limit?: number;
|
|
2138
|
+
search?: string;
|
|
2139
|
+
};
|
|
2140
|
+
header?: never;
|
|
2141
|
+
path?: never;
|
|
2142
|
+
cookie?: never;
|
|
2143
|
+
};
|
|
2144
|
+
requestBody?: never;
|
|
2145
|
+
responses: {
|
|
2146
|
+
/** @description Página de BDRs */
|
|
2147
|
+
200: {
|
|
2148
|
+
headers: {
|
|
2149
|
+
[name: string]: unknown;
|
|
2150
|
+
};
|
|
2151
|
+
content: {
|
|
2152
|
+
"application/json": {
|
|
2153
|
+
data: components["schemas"]["BdrProfile"][];
|
|
2154
|
+
meta: {
|
|
2155
|
+
next_cursor: string | null;
|
|
2156
|
+
/** @description Itens nesta página */
|
|
2157
|
+
count: number;
|
|
2158
|
+
};
|
|
2159
|
+
};
|
|
2160
|
+
};
|
|
2161
|
+
};
|
|
2162
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
2163
|
+
default: {
|
|
2164
|
+
headers: {
|
|
2165
|
+
[name: string]: unknown;
|
|
2166
|
+
};
|
|
2167
|
+
content: {
|
|
2168
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
2169
|
+
};
|
|
2170
|
+
};
|
|
2171
|
+
};
|
|
2172
|
+
};
|
|
2173
|
+
getBdr: {
|
|
2174
|
+
parameters: {
|
|
2175
|
+
query?: never;
|
|
2176
|
+
header?: never;
|
|
2177
|
+
path: {
|
|
2178
|
+
ticker: string;
|
|
2179
|
+
};
|
|
2180
|
+
cookie?: never;
|
|
2181
|
+
};
|
|
2182
|
+
requestBody?: never;
|
|
2183
|
+
responses: {
|
|
2184
|
+
/** @description BDR */
|
|
2185
|
+
200: {
|
|
2186
|
+
headers: {
|
|
2187
|
+
[name: string]: unknown;
|
|
2188
|
+
};
|
|
2189
|
+
content: {
|
|
2190
|
+
"application/json": components["schemas"]["BdrProfile"];
|
|
2191
|
+
};
|
|
2192
|
+
};
|
|
2193
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
2194
|
+
default: {
|
|
2195
|
+
headers: {
|
|
2196
|
+
[name: string]: unknown;
|
|
2197
|
+
};
|
|
2198
|
+
content: {
|
|
2199
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
2200
|
+
};
|
|
2201
|
+
};
|
|
2202
|
+
};
|
|
2203
|
+
};
|
|
2204
|
+
listBdrQuotes: {
|
|
2205
|
+
parameters: {
|
|
2206
|
+
query?: {
|
|
2207
|
+
cursor?: string;
|
|
2208
|
+
limit?: number;
|
|
2209
|
+
from?: string;
|
|
2210
|
+
to?: string;
|
|
2211
|
+
};
|
|
2212
|
+
header?: never;
|
|
2213
|
+
path: {
|
|
2214
|
+
ticker: string;
|
|
2215
|
+
};
|
|
2216
|
+
cookie?: never;
|
|
2217
|
+
};
|
|
2218
|
+
requestBody?: never;
|
|
2219
|
+
responses: {
|
|
2220
|
+
/** @description Página de cotações */
|
|
2221
|
+
200: {
|
|
2222
|
+
headers: {
|
|
2223
|
+
[name: string]: unknown;
|
|
2224
|
+
};
|
|
2225
|
+
content: {
|
|
2226
|
+
"application/json": {
|
|
2227
|
+
data: components["schemas"]["BdrQuote"][];
|
|
2228
|
+
meta: {
|
|
2229
|
+
next_cursor: string | null;
|
|
2230
|
+
/** @description Itens nesta página */
|
|
2231
|
+
count: number;
|
|
2232
|
+
};
|
|
2233
|
+
};
|
|
2234
|
+
};
|
|
2235
|
+
};
|
|
2236
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
2237
|
+
default: {
|
|
2238
|
+
headers: {
|
|
2239
|
+
[name: string]: unknown;
|
|
2240
|
+
};
|
|
2241
|
+
content: {
|
|
2242
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
2243
|
+
};
|
|
2244
|
+
};
|
|
2245
|
+
};
|
|
2246
|
+
};
|
|
2247
|
+
getOptionsChain: {
|
|
2248
|
+
parameters: {
|
|
2249
|
+
query?: {
|
|
2250
|
+
expiry?: string;
|
|
2251
|
+
type?: "call" | "put";
|
|
2252
|
+
};
|
|
2253
|
+
header?: never;
|
|
2254
|
+
path: {
|
|
2255
|
+
ticker: string;
|
|
2256
|
+
};
|
|
2257
|
+
cookie?: never;
|
|
2258
|
+
};
|
|
2259
|
+
requestBody?: never;
|
|
2260
|
+
responses: {
|
|
2261
|
+
/** @description Cadeia de opções */
|
|
2262
|
+
200: {
|
|
2263
|
+
headers: {
|
|
2264
|
+
[name: string]: unknown;
|
|
2265
|
+
};
|
|
2266
|
+
content: {
|
|
2267
|
+
"application/json": components["schemas"]["OptionsChain"];
|
|
2268
|
+
};
|
|
2269
|
+
};
|
|
2270
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
2271
|
+
default: {
|
|
2272
|
+
headers: {
|
|
2273
|
+
[name: string]: unknown;
|
|
2274
|
+
};
|
|
2275
|
+
content: {
|
|
2276
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
2277
|
+
};
|
|
2278
|
+
};
|
|
2279
|
+
};
|
|
2280
|
+
};
|
|
2281
|
+
listOptionExpiries: {
|
|
2282
|
+
parameters: {
|
|
2283
|
+
query?: never;
|
|
2284
|
+
header?: never;
|
|
2285
|
+
path: {
|
|
2286
|
+
ticker: string;
|
|
2287
|
+
};
|
|
2288
|
+
cookie?: never;
|
|
2289
|
+
};
|
|
2290
|
+
requestBody?: never;
|
|
2291
|
+
responses: {
|
|
2292
|
+
/** @description Vencimentos */
|
|
2293
|
+
200: {
|
|
2294
|
+
headers: {
|
|
2295
|
+
[name: string]: unknown;
|
|
2296
|
+
};
|
|
2297
|
+
content: {
|
|
2298
|
+
"application/json": components["schemas"]["OptionExpiries"];
|
|
2299
|
+
};
|
|
2300
|
+
};
|
|
2301
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
2302
|
+
default: {
|
|
2303
|
+
headers: {
|
|
2304
|
+
[name: string]: unknown;
|
|
2305
|
+
};
|
|
2306
|
+
content: {
|
|
2307
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
2308
|
+
};
|
|
2309
|
+
};
|
|
2310
|
+
};
|
|
2311
|
+
};
|
|
2312
|
+
listOptionQuotes: {
|
|
2313
|
+
parameters: {
|
|
2314
|
+
query?: {
|
|
2315
|
+
cursor?: string;
|
|
2316
|
+
limit?: number;
|
|
2317
|
+
from?: string;
|
|
2318
|
+
to?: string;
|
|
2319
|
+
};
|
|
2320
|
+
header?: never;
|
|
2321
|
+
path: {
|
|
2322
|
+
option: string;
|
|
2323
|
+
};
|
|
2324
|
+
cookie?: never;
|
|
2325
|
+
};
|
|
2326
|
+
requestBody?: never;
|
|
2327
|
+
responses: {
|
|
2328
|
+
/** @description Página de cotações */
|
|
2329
|
+
200: {
|
|
2330
|
+
headers: {
|
|
2331
|
+
[name: string]: unknown;
|
|
2332
|
+
};
|
|
2333
|
+
content: {
|
|
2334
|
+
"application/json": {
|
|
2335
|
+
data: components["schemas"]["OptionQuote"][];
|
|
2336
|
+
meta: {
|
|
2337
|
+
next_cursor: string | null;
|
|
2338
|
+
/** @description Itens nesta página */
|
|
2339
|
+
count: number;
|
|
2340
|
+
};
|
|
2341
|
+
};
|
|
2342
|
+
};
|
|
2343
|
+
};
|
|
2344
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
2345
|
+
default: {
|
|
2346
|
+
headers: {
|
|
2347
|
+
[name: string]: unknown;
|
|
2348
|
+
};
|
|
2349
|
+
content: {
|
|
2350
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
2351
|
+
};
|
|
2352
|
+
};
|
|
2353
|
+
};
|
|
2354
|
+
};
|
|
2355
|
+
listCryptoQuotes: {
|
|
2356
|
+
parameters: {
|
|
2357
|
+
query?: {
|
|
2358
|
+
cursor?: string;
|
|
2359
|
+
limit?: number;
|
|
2360
|
+
interval?: "1d" | "1h";
|
|
2361
|
+
from?: string;
|
|
2362
|
+
to?: string;
|
|
2363
|
+
};
|
|
2364
|
+
header?: never;
|
|
2365
|
+
path: {
|
|
2366
|
+
symbol: string;
|
|
2367
|
+
};
|
|
2368
|
+
cookie?: never;
|
|
2369
|
+
};
|
|
2370
|
+
requestBody?: never;
|
|
2371
|
+
responses: {
|
|
2372
|
+
/** @description Página de candles */
|
|
2373
|
+
200: {
|
|
2374
|
+
headers: {
|
|
2375
|
+
[name: string]: unknown;
|
|
2376
|
+
};
|
|
2377
|
+
content: {
|
|
2378
|
+
"application/json": {
|
|
2379
|
+
data: components["schemas"]["CryptoCandle"][];
|
|
2380
|
+
meta: {
|
|
2381
|
+
next_cursor: string | null;
|
|
2382
|
+
/** @description Itens nesta página */
|
|
2383
|
+
count: number;
|
|
2384
|
+
};
|
|
2385
|
+
};
|
|
2386
|
+
};
|
|
2387
|
+
};
|
|
2388
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
2389
|
+
default: {
|
|
2390
|
+
headers: {
|
|
2391
|
+
[name: string]: unknown;
|
|
2392
|
+
};
|
|
2393
|
+
content: {
|
|
2394
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
2395
|
+
};
|
|
2396
|
+
};
|
|
2397
|
+
};
|
|
2398
|
+
};
|
|
2399
|
+
search: {
|
|
2400
|
+
parameters: {
|
|
2401
|
+
query: {
|
|
2402
|
+
q: string;
|
|
2403
|
+
limit?: number;
|
|
2404
|
+
};
|
|
2405
|
+
header?: never;
|
|
2406
|
+
path?: never;
|
|
2407
|
+
cookie?: never;
|
|
2408
|
+
};
|
|
2409
|
+
requestBody?: never;
|
|
2410
|
+
responses: {
|
|
2411
|
+
/** @description Resultados ranqueados */
|
|
2412
|
+
200: {
|
|
2413
|
+
headers: {
|
|
2414
|
+
[name: string]: unknown;
|
|
2415
|
+
};
|
|
2416
|
+
content: {
|
|
2417
|
+
"application/json": components["schemas"]["SearchResult"][];
|
|
2418
|
+
};
|
|
2419
|
+
};
|
|
2420
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
2421
|
+
default: {
|
|
2422
|
+
headers: {
|
|
2423
|
+
[name: string]: unknown;
|
|
2424
|
+
};
|
|
2425
|
+
content: {
|
|
2426
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
2427
|
+
};
|
|
2428
|
+
};
|
|
2429
|
+
};
|
|
2430
|
+
};
|
|
2431
|
+
getIngestHealth: {
|
|
2432
|
+
parameters: {
|
|
2433
|
+
query?: never;
|
|
2434
|
+
header?: never;
|
|
2435
|
+
path?: never;
|
|
2436
|
+
cookie?: never;
|
|
2437
|
+
};
|
|
2438
|
+
requestBody?: never;
|
|
2439
|
+
responses: {
|
|
2440
|
+
/** @description Saúde da ingestão */
|
|
2441
|
+
200: {
|
|
2442
|
+
headers: {
|
|
2443
|
+
[name: string]: unknown;
|
|
2444
|
+
};
|
|
2445
|
+
content: {
|
|
2446
|
+
"application/json": {
|
|
2447
|
+
latest: ({
|
|
2448
|
+
errors: string[];
|
|
2449
|
+
} & components["schemas"]["IngestRunSummary"]) | null;
|
|
2450
|
+
sources: components["schemas"]["IngestSourceHealth"][];
|
|
2451
|
+
recent_runs: components["schemas"]["IngestRunSummary"][];
|
|
2452
|
+
};
|
|
2453
|
+
};
|
|
2454
|
+
};
|
|
2455
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
2456
|
+
default: {
|
|
2457
|
+
headers: {
|
|
2458
|
+
[name: string]: unknown;
|
|
2459
|
+
};
|
|
2460
|
+
content: {
|
|
2461
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
2462
|
+
};
|
|
2463
|
+
};
|
|
2464
|
+
};
|
|
2465
|
+
};
|
|
2466
|
+
}
|