@databolsa/sdk 1.0.11 → 1.0.12
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/dist/client.d.ts +31 -1
- package/dist/http-client.d.ts +25 -1
- package/dist/index.js +40 -0
- package/dist/schema.d.ts +472 -2
- package/dist/types.d.ts +7 -0
- package/package.json +1 -1
package/dist/client.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { CorporateEventsResponse, CryptoQuotesResponse, DividendsResponse, DocumentsResponse, EtfListResponse, EtfProfile, ExpectationsResponse, Fii, FiiDistributionsResponse, FiiIndicatorsResponse, FiiReportsResponse, FiiScreenResponse, FundHoldersResponse, FundHoldingsResponse, FundListResponse, FundProfile, FundQuotesResponse, FundScreenerResponse, HealthResponse, IngestHealthResponse, IndexCompositionResponse, IndexMeta, IndexQuotesResponse, IndicatorHistoryResponse, IntradaySeriesResponse, LiveQuotesResponse, BdrListResponse, BdrProfile, BdrQuotesResponse, InsiderResponse, InvestorFlowMonthlyResponse, InvestorFlowResponse, MacroGearsResponse, OfferingsResponse, OptionExpiriesResponse, OptionsChainResponse, OptionsQuotesResponse, DocumentSearchResponse, PortfolioResponse, CommunityBotsResponse, CommunityBotPostInput, CommunityBotPostResponse, CommunityBotReplyResponse, CommunityFeedParams, CommunityFeedResponse, CommunityPostResponse, RegisterCommunityBotInput, RegisterCommunityBotResponse, Query, QuotesResponse, RangeParams, RegimeSnapshot, ScreenStocksResponse, SearchDocumentsParams, SearchResult, SeriesResponse, Stock, StockIndicatorsResponse, SuitabilityResponse, TesouroBondsResponse, TradeStatsResponse, YieldCurveResponse, AddPortfolioTransactionResponse, CreatePortfolioResponse, PortfolioAssetRef, PortfolioDetail, PortfolioHistoryResponse, PortfolioImportInput, PortfolioImportRowsResponse, PortfolioImportsResponse, PortfolioImportSummary, PortfolioPatch, PortfolioRfContract, PortfolioTransaction, PortfolioTransactionInput, PortfolioTransactionPatch, PortfoliosResponse, PortfolioTransactionsResponse } from "./types";
|
|
1
|
+
import type { CorporateEventsResponse, CryptoAsset, CryptoListResponse, CryptoLiveResponse, CryptoQuotesResponse, UsAssetsResponse, UsAssetDetail, UsQuotesResponse, UsFilingsResponse, DividendsResponse, DocumentsResponse, EtfListResponse, EtfProfile, ExpectationsResponse, Fii, FiiDistributionsResponse, FiiIndicatorsResponse, FiiReportsResponse, FiiScreenResponse, FundHoldersResponse, FundHoldingsResponse, FundListResponse, FundProfile, FundQuotesResponse, FundScreenerResponse, HealthResponse, IngestHealthResponse, IndexCompositionResponse, IndexMeta, IndexQuotesResponse, IndicatorHistoryResponse, IntradaySeriesResponse, LiveQuotesResponse, BdrListResponse, BdrProfile, BdrQuotesResponse, InsiderResponse, InvestorFlowMonthlyResponse, InvestorFlowResponse, MacroGearsResponse, OfferingsResponse, OptionExpiriesResponse, OptionsChainResponse, OptionsQuotesResponse, DocumentSearchResponse, PortfolioResponse, CommunityBotsResponse, CommunityBotPostInput, CommunityBotPostResponse, CommunityBotReplyResponse, CommunityFeedParams, CommunityFeedResponse, CommunityPostResponse, RegisterCommunityBotInput, RegisterCommunityBotResponse, Query, QuotesResponse, RangeParams, RegimeSnapshot, ScreenStocksResponse, SearchDocumentsParams, SearchResult, SeriesResponse, Stock, StockIndicatorsResponse, SuitabilityResponse, TesouroBondsResponse, TradeStatsResponse, YieldCurveResponse, AddPortfolioTransactionResponse, CreatePortfolioResponse, PortfolioAssetRef, PortfolioDetail, PortfolioHistoryResponse, PortfolioImportInput, PortfolioImportRowsResponse, PortfolioImportsResponse, PortfolioImportSummary, PortfolioPatch, PortfolioRfContract, PortfolioTransaction, PortfolioTransactionInput, PortfolioTransactionPatch, PortfoliosResponse, PortfolioTransactionsResponse } from "./types";
|
|
2
2
|
/** Filtros do screener de ações — derivados de `GET /v1/screener/stocks`. */
|
|
3
3
|
export type ScreenStocksParams = Query<"screenStocks">;
|
|
4
4
|
/**
|
|
@@ -155,10 +155,40 @@ export interface DataBolsaClient {
|
|
|
155
155
|
getMacroGears(params?: {
|
|
156
156
|
gear?: string;
|
|
157
157
|
}): Promise<MacroGearsResponse>;
|
|
158
|
+
/** Catálogo de criptoativos (paginado; busca por símbolo/nome). */
|
|
159
|
+
listCrypto(params?: {
|
|
160
|
+
search?: string;
|
|
161
|
+
limit?: number;
|
|
162
|
+
cursor?: string;
|
|
163
|
+
}): Promise<CryptoListResponse>;
|
|
164
|
+
getCrypto(symbol: string): Promise<CryptoAsset>;
|
|
165
|
+
/** Snapshot quase-live (~1 min, 24/7) de todo o universo de cripto. */
|
|
166
|
+
listCryptoLive(): Promise<CryptoLiveResponse>;
|
|
158
167
|
listCryptoQuotes(symbol: string, params?: RangeParams & {
|
|
159
168
|
interval?: "1d" | "1h";
|
|
160
169
|
limit?: number;
|
|
161
170
|
}): Promise<CryptoQuotesResponse>;
|
|
171
|
+
/** Catálogo de ativos dos EUA (paginado; filtra por tipo, busca por ticker/nome). */
|
|
172
|
+
listUsAssets(params?: {
|
|
173
|
+
search?: string;
|
|
174
|
+
type?: "stock" | "etf";
|
|
175
|
+
bdr?: string;
|
|
176
|
+
limit?: number;
|
|
177
|
+
cursor?: string;
|
|
178
|
+
}): Promise<UsAssetsResponse>;
|
|
179
|
+
/** Perfil de um ativo dos EUA com fundamentos SEC inline. */
|
|
180
|
+
getUsAsset(ticker: string): Promise<UsAssetDetail>;
|
|
181
|
+
/** Cotações EOD em USD (ajustadas por desdobramento na fonte). */
|
|
182
|
+
listUsAssetQuotes(ticker: string, params?: RangeParams & {
|
|
183
|
+
limit?: number;
|
|
184
|
+
cursor?: string;
|
|
185
|
+
}): Promise<UsQuotesResponse>;
|
|
186
|
+
/** Filings SEC (10-K/10-Q/8-K…) com link do documento no EDGAR. */
|
|
187
|
+
listUsFilings(ticker: string, params?: {
|
|
188
|
+
form?: string;
|
|
189
|
+
limit?: number;
|
|
190
|
+
cursor?: string;
|
|
191
|
+
}): Promise<UsFilingsResponse>;
|
|
162
192
|
/** Cadeia viva de um subjacente (séries não vencidas, mais negociadas). Filtra por vencimento/tipo. */
|
|
163
193
|
listOptionsChain(underlying: string, params?: {
|
|
164
194
|
expiry?: string;
|
package/dist/http-client.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type DataBolsaClient, type LiveQuotesParams, type ScreenFiisParams, type ScreenFundsParams, type ScreenStocksParams } from "./client";
|
|
2
|
-
import type { AddPortfolioTransactionResponse, CreatePortfolioResponse, PortfolioAssetRef, PortfolioDetail, PortfolioHistoryResponse, PortfolioImportInput, PortfolioImportRowsResponse, PortfolioImportsResponse, PortfolioImportSummary, PortfolioPatch, PortfolioRfContract, PortfolioTransaction, PortfolioTransactionInput, PortfolioTransactionPatch, PortfoliosResponse, PortfolioTransactionsResponse, CorporateEventsResponse, CryptoQuotesResponse, DividendsResponse, DocumentSearchResponse, DocumentsResponse, EtfListResponse, EtfProfile, ExpectationsResponse, Fii, FiiDistributionsResponse, FiiIndicatorsResponse, FiiReportsResponse, FiiScreenResponse, FundHoldersResponse, FundHoldingsResponse, FundListResponse, FundProfile, FundQuotesResponse, FundScreenerResponse, HealthResponse, IngestHealthResponse, IndexCompositionResponse, IndexMeta, IndexQuotesResponse, IndicatorHistoryResponse, IntradaySeriesResponse, LiveQuotesResponse, BdrListResponse, BdrProfile, BdrQuotesResponse, InsiderResponse, InvestorFlowMonthlyResponse, InvestorFlowResponse, MacroGearsResponse, OfferingsResponse, OptionExpiriesResponse, OptionsChainResponse, OptionsQuotesResponse, PortfolioResponse, CommunityBotsResponse, CommunityBotPostInput, CommunityBotPostResponse, CommunityBotReplyResponse, CommunityFeedParams, CommunityFeedResponse, CommunityPostResponse, RegisterCommunityBotInput, RegisterCommunityBotResponse, QuotesResponse, RangeParams, RegimeSnapshot, ScreenStocksResponse, SearchDocumentsParams, SearchResult, SeriesResponse, Stock, StockIndicatorsResponse, SuitabilityResponse, TesouroBondsResponse, TradeStatsResponse, YieldCurveResponse } from "./types";
|
|
2
|
+
import type { AddPortfolioTransactionResponse, CreatePortfolioResponse, PortfolioAssetRef, PortfolioDetail, PortfolioHistoryResponse, PortfolioImportInput, PortfolioImportRowsResponse, PortfolioImportsResponse, PortfolioImportSummary, PortfolioPatch, PortfolioRfContract, PortfolioTransaction, PortfolioTransactionInput, PortfolioTransactionPatch, PortfoliosResponse, PortfolioTransactionsResponse, CorporateEventsResponse, CryptoAsset, CryptoListResponse, CryptoLiveResponse, CryptoQuotesResponse, UsAssetsResponse, UsAssetDetail, UsQuotesResponse, UsFilingsResponse, DividendsResponse, DocumentSearchResponse, DocumentsResponse, EtfListResponse, EtfProfile, ExpectationsResponse, Fii, FiiDistributionsResponse, FiiIndicatorsResponse, FiiReportsResponse, FiiScreenResponse, FundHoldersResponse, FundHoldingsResponse, FundListResponse, FundProfile, FundQuotesResponse, FundScreenerResponse, HealthResponse, IngestHealthResponse, IndexCompositionResponse, IndexMeta, IndexQuotesResponse, IndicatorHistoryResponse, IntradaySeriesResponse, LiveQuotesResponse, BdrListResponse, BdrProfile, BdrQuotesResponse, InsiderResponse, InvestorFlowMonthlyResponse, InvestorFlowResponse, MacroGearsResponse, OfferingsResponse, OptionExpiriesResponse, OptionsChainResponse, OptionsQuotesResponse, PortfolioResponse, CommunityBotsResponse, CommunityBotPostInput, CommunityBotPostResponse, CommunityBotReplyResponse, CommunityFeedParams, CommunityFeedResponse, CommunityPostResponse, RegisterCommunityBotInput, RegisterCommunityBotResponse, QuotesResponse, RangeParams, RegimeSnapshot, ScreenStocksResponse, SearchDocumentsParams, SearchResult, SeriesResponse, Stock, StockIndicatorsResponse, SuitabilityResponse, TesouroBondsResponse, TradeStatsResponse, YieldCurveResponse } from "./types";
|
|
3
3
|
/**
|
|
4
4
|
* Cliente HTTP da Serving API do DataBolsa. Os métodos públicos espelham os
|
|
5
5
|
* operationIds do OpenAPI e retornam tipos gerados.
|
|
@@ -137,10 +137,34 @@ export declare class HttpClient implements DataBolsaClient {
|
|
|
137
137
|
getMacroGears(params?: {
|
|
138
138
|
gear?: string;
|
|
139
139
|
}): Promise<MacroGearsResponse>;
|
|
140
|
+
listCrypto(params?: {
|
|
141
|
+
search?: string;
|
|
142
|
+
limit?: number;
|
|
143
|
+
cursor?: string;
|
|
144
|
+
}): Promise<CryptoListResponse>;
|
|
145
|
+
getCrypto(symbol: string): Promise<CryptoAsset>;
|
|
146
|
+
listCryptoLive(): Promise<CryptoLiveResponse>;
|
|
140
147
|
listCryptoQuotes(symbol: string, params?: RangeParams & {
|
|
141
148
|
interval?: "1d" | "1h";
|
|
142
149
|
limit?: number;
|
|
143
150
|
}): Promise<CryptoQuotesResponse>;
|
|
151
|
+
listUsAssets(params?: {
|
|
152
|
+
search?: string;
|
|
153
|
+
type?: "stock" | "etf";
|
|
154
|
+
bdr?: string;
|
|
155
|
+
limit?: number;
|
|
156
|
+
cursor?: string;
|
|
157
|
+
}): Promise<UsAssetsResponse>;
|
|
158
|
+
getUsAsset(ticker: string): Promise<UsAssetDetail>;
|
|
159
|
+
listUsAssetQuotes(ticker: string, params?: RangeParams & {
|
|
160
|
+
limit?: number;
|
|
161
|
+
cursor?: string;
|
|
162
|
+
}): Promise<UsQuotesResponse>;
|
|
163
|
+
listUsFilings(ticker: string, params?: {
|
|
164
|
+
form?: string;
|
|
165
|
+
limit?: number;
|
|
166
|
+
cursor?: string;
|
|
167
|
+
}): Promise<UsFilingsResponse>;
|
|
144
168
|
listOptionsChain(underlying: string, params?: {
|
|
145
169
|
expiry?: string;
|
|
146
170
|
type?: "call" | "put";
|
package/dist/index.js
CHANGED
|
@@ -336,6 +336,19 @@ class HttpClient {
|
|
|
336
336
|
getMacroGears(params) {
|
|
337
337
|
return this.request("/macro/gears", { gear: params?.gear });
|
|
338
338
|
}
|
|
339
|
+
listCrypto(params) {
|
|
340
|
+
return this.request("/crypto", {
|
|
341
|
+
search: params?.search,
|
|
342
|
+
limit: params?.limit,
|
|
343
|
+
cursor: params?.cursor
|
|
344
|
+
});
|
|
345
|
+
}
|
|
346
|
+
getCrypto(symbol) {
|
|
347
|
+
return this.request(`/crypto/${enc(symbol)}`);
|
|
348
|
+
}
|
|
349
|
+
listCryptoLive() {
|
|
350
|
+
return this.request("/crypto/live");
|
|
351
|
+
}
|
|
339
352
|
listCryptoQuotes(symbol, params) {
|
|
340
353
|
return this.request(`/crypto/${enc(symbol)}/quotes`, {
|
|
341
354
|
interval: params?.interval,
|
|
@@ -344,6 +357,33 @@ class HttpClient {
|
|
|
344
357
|
limit: params?.limit
|
|
345
358
|
});
|
|
346
359
|
}
|
|
360
|
+
listUsAssets(params) {
|
|
361
|
+
return this.request("/us/assets", {
|
|
362
|
+
search: params?.search,
|
|
363
|
+
type: params?.type,
|
|
364
|
+
bdr: params?.bdr,
|
|
365
|
+
limit: params?.limit,
|
|
366
|
+
cursor: params?.cursor
|
|
367
|
+
});
|
|
368
|
+
}
|
|
369
|
+
getUsAsset(ticker) {
|
|
370
|
+
return this.request(`/us/assets/${enc(ticker)}`);
|
|
371
|
+
}
|
|
372
|
+
listUsAssetQuotes(ticker, params) {
|
|
373
|
+
return this.request(`/us/assets/${enc(ticker)}/quotes`, {
|
|
374
|
+
from: params?.from,
|
|
375
|
+
to: params?.to,
|
|
376
|
+
limit: params?.limit,
|
|
377
|
+
cursor: params?.cursor
|
|
378
|
+
});
|
|
379
|
+
}
|
|
380
|
+
listUsFilings(ticker, params) {
|
|
381
|
+
return this.request(`/us/assets/${enc(ticker)}/filings`, {
|
|
382
|
+
form: params?.form,
|
|
383
|
+
limit: params?.limit,
|
|
384
|
+
cursor: params?.cursor
|
|
385
|
+
});
|
|
386
|
+
}
|
|
347
387
|
listOptionsChain(underlying, params) {
|
|
348
388
|
return this.request(`/options/${enc(underlying)}/chain`, {
|
|
349
389
|
expiry: params?.expiry,
|
package/dist/schema.d.ts
CHANGED
|
@@ -896,6 +896,57 @@ export interface paths {
|
|
|
896
896
|
patch?: never;
|
|
897
897
|
trace?: never;
|
|
898
898
|
};
|
|
899
|
+
"/v1/crypto": {
|
|
900
|
+
parameters: {
|
|
901
|
+
query?: never;
|
|
902
|
+
header?: never;
|
|
903
|
+
path?: never;
|
|
904
|
+
cookie?: never;
|
|
905
|
+
};
|
|
906
|
+
/** Catálogo de criptoativos (velas diárias em BRL) */
|
|
907
|
+
get: operations["listCrypto"];
|
|
908
|
+
put?: never;
|
|
909
|
+
post?: never;
|
|
910
|
+
delete?: never;
|
|
911
|
+
options?: never;
|
|
912
|
+
head?: never;
|
|
913
|
+
patch?: never;
|
|
914
|
+
trace?: never;
|
|
915
|
+
};
|
|
916
|
+
"/v1/crypto/live": {
|
|
917
|
+
parameters: {
|
|
918
|
+
query?: never;
|
|
919
|
+
header?: never;
|
|
920
|
+
path?: never;
|
|
921
|
+
cookie?: never;
|
|
922
|
+
};
|
|
923
|
+
/** Cotações quase-live de cripto (snapshot ~1 min, 24/7) */
|
|
924
|
+
get: operations["listCryptoLive"];
|
|
925
|
+
put?: never;
|
|
926
|
+
post?: never;
|
|
927
|
+
delete?: never;
|
|
928
|
+
options?: never;
|
|
929
|
+
head?: never;
|
|
930
|
+
patch?: never;
|
|
931
|
+
trace?: never;
|
|
932
|
+
};
|
|
933
|
+
"/v1/crypto/{symbol}": {
|
|
934
|
+
parameters: {
|
|
935
|
+
query?: never;
|
|
936
|
+
header?: never;
|
|
937
|
+
path?: never;
|
|
938
|
+
cookie?: never;
|
|
939
|
+
};
|
|
940
|
+
/** Perfil de um criptoativo */
|
|
941
|
+
get: operations["getCrypto"];
|
|
942
|
+
put?: never;
|
|
943
|
+
post?: never;
|
|
944
|
+
delete?: never;
|
|
945
|
+
options?: never;
|
|
946
|
+
head?: never;
|
|
947
|
+
patch?: never;
|
|
948
|
+
trace?: never;
|
|
949
|
+
};
|
|
899
950
|
"/v1/crypto/{symbol}/quotes": {
|
|
900
951
|
parameters: {
|
|
901
952
|
query?: never;
|
|
@@ -913,6 +964,80 @@ export interface paths {
|
|
|
913
964
|
patch?: never;
|
|
914
965
|
trace?: never;
|
|
915
966
|
};
|
|
967
|
+
"/v1/us/assets": {
|
|
968
|
+
parameters: {
|
|
969
|
+
query?: never;
|
|
970
|
+
header?: never;
|
|
971
|
+
path?: never;
|
|
972
|
+
cookie?: never;
|
|
973
|
+
};
|
|
974
|
+
/** Catálogo de ativos dos EUA (ações S&P 500/Nasdaq-100 + ETFs) */
|
|
975
|
+
get: operations["listUsAssets"];
|
|
976
|
+
put?: never;
|
|
977
|
+
post?: never;
|
|
978
|
+
delete?: never;
|
|
979
|
+
options?: never;
|
|
980
|
+
head?: never;
|
|
981
|
+
patch?: never;
|
|
982
|
+
trace?: never;
|
|
983
|
+
};
|
|
984
|
+
"/v1/us/assets/{ticker}": {
|
|
985
|
+
parameters: {
|
|
986
|
+
query?: never;
|
|
987
|
+
header?: never;
|
|
988
|
+
path?: never;
|
|
989
|
+
cookie?: never;
|
|
990
|
+
};
|
|
991
|
+
/** Perfil de um ativo dos EUA (com fundamentos SEC inline) */
|
|
992
|
+
get: operations["getUsAsset"];
|
|
993
|
+
put?: never;
|
|
994
|
+
post?: never;
|
|
995
|
+
delete?: never;
|
|
996
|
+
options?: never;
|
|
997
|
+
head?: never;
|
|
998
|
+
patch?: never;
|
|
999
|
+
trace?: never;
|
|
1000
|
+
};
|
|
1001
|
+
"/v1/us/assets/{ticker}/quotes": {
|
|
1002
|
+
parameters: {
|
|
1003
|
+
query?: never;
|
|
1004
|
+
header?: never;
|
|
1005
|
+
path?: never;
|
|
1006
|
+
cookie?: never;
|
|
1007
|
+
};
|
|
1008
|
+
/**
|
|
1009
|
+
* Cotações EOD de um ativo dos EUA (USD)
|
|
1010
|
+
* @description Preços diários em USD, ajustados por desdobramento na fonte.
|
|
1011
|
+
*/
|
|
1012
|
+
get: operations["listUsAssetQuotes"];
|
|
1013
|
+
put?: never;
|
|
1014
|
+
post?: never;
|
|
1015
|
+
delete?: never;
|
|
1016
|
+
options?: never;
|
|
1017
|
+
head?: never;
|
|
1018
|
+
patch?: never;
|
|
1019
|
+
trace?: never;
|
|
1020
|
+
};
|
|
1021
|
+
"/v1/us/assets/{ticker}/filings": {
|
|
1022
|
+
parameters: {
|
|
1023
|
+
query?: never;
|
|
1024
|
+
header?: never;
|
|
1025
|
+
path?: never;
|
|
1026
|
+
cookie?: never;
|
|
1027
|
+
};
|
|
1028
|
+
/**
|
|
1029
|
+
* Filings SEC de uma empresa dos EUA (10-K, 10-Q, 8-K…)
|
|
1030
|
+
* @description Metadados e link do documento oficial no EDGAR (SEC).
|
|
1031
|
+
*/
|
|
1032
|
+
get: operations["listUsFilings"];
|
|
1033
|
+
put?: never;
|
|
1034
|
+
post?: never;
|
|
1035
|
+
delete?: never;
|
|
1036
|
+
options?: never;
|
|
1037
|
+
head?: never;
|
|
1038
|
+
patch?: never;
|
|
1039
|
+
trace?: never;
|
|
1040
|
+
};
|
|
916
1041
|
"/v1/search": {
|
|
917
1042
|
parameters: {
|
|
918
1043
|
query?: never;
|
|
@@ -2038,6 +2163,36 @@ export interface components {
|
|
|
2038
2163
|
vega: number | null;
|
|
2039
2164
|
theta: number | null;
|
|
2040
2165
|
};
|
|
2166
|
+
CryptoAsset: {
|
|
2167
|
+
/** @description Ativo-base canônico, ex.: BTC */
|
|
2168
|
+
symbol: string;
|
|
2169
|
+
name: string | null;
|
|
2170
|
+
/** @description Ordem curada por relevância/market cap */
|
|
2171
|
+
rank: number | null;
|
|
2172
|
+
first_date: string | null;
|
|
2173
|
+
last_date: string | null;
|
|
2174
|
+
close_brl: number | null;
|
|
2175
|
+
close_usd: number | null;
|
|
2176
|
+
change_pct_1d: number | null;
|
|
2177
|
+
change_pct_7d: number | null;
|
|
2178
|
+
/** @description Volume negociado em BRL na última vela diária */
|
|
2179
|
+
volume_brl_1d: number | null;
|
|
2180
|
+
};
|
|
2181
|
+
CryptoLiveResponse: {
|
|
2182
|
+
data: components["schemas"]["CryptoLiveQuote"][];
|
|
2183
|
+
/** @description Timestamp mais recente do lote */
|
|
2184
|
+
as_of: string | null;
|
|
2185
|
+
};
|
|
2186
|
+
CryptoLiveQuote: {
|
|
2187
|
+
symbol: string;
|
|
2188
|
+
price_brl: number;
|
|
2189
|
+
price_usd: number | null;
|
|
2190
|
+
/** @description Variação % em 24h rolantes */
|
|
2191
|
+
change_pct_24h: number | null;
|
|
2192
|
+
volume_usd_24h: number | null;
|
|
2193
|
+
/** @description Timestamp do snapshot (UTC) */
|
|
2194
|
+
ts: string;
|
|
2195
|
+
};
|
|
2041
2196
|
CryptoCandle: {
|
|
2042
2197
|
open_time: string;
|
|
2043
2198
|
close_time: string;
|
|
@@ -2050,10 +2205,67 @@ export interface components {
|
|
|
2050
2205
|
/** @description Volume em BRL */
|
|
2051
2206
|
quote_volume: number | null;
|
|
2052
2207
|
trades: number | null;
|
|
2208
|
+
/** @description Fechamento em USD */
|
|
2209
|
+
close_usd: number | null;
|
|
2210
|
+
};
|
|
2211
|
+
UsAsset: {
|
|
2212
|
+
ticker: string;
|
|
2213
|
+
name: string | null;
|
|
2214
|
+
/** @enum {string} */
|
|
2215
|
+
type: "stock" | "etf";
|
|
2216
|
+
in_sp500: boolean | null;
|
|
2217
|
+
in_ndx100: boolean | null;
|
|
2218
|
+
/** @description BDR correspondente na B3, quando mapeado */
|
|
2219
|
+
bdr_ticker: string | null;
|
|
2220
|
+
first_date: string | null;
|
|
2221
|
+
last_date: string | null;
|
|
2222
|
+
close_usd: number | null;
|
|
2223
|
+
change_pct_1d: number | null;
|
|
2224
|
+
change_pct_1m: number | null;
|
|
2225
|
+
change_pct_1y: number | null;
|
|
2226
|
+
high_52w: number | null;
|
|
2227
|
+
low_52w: number | null;
|
|
2228
|
+
volume_1d: number | null;
|
|
2229
|
+
};
|
|
2230
|
+
UsAssetDetail: {
|
|
2231
|
+
fundamentals: components["schemas"]["UsFundamental"][];
|
|
2232
|
+
} & components["schemas"]["UsAsset"];
|
|
2233
|
+
UsFundamental: {
|
|
2234
|
+
/** @enum {string} */
|
|
2235
|
+
metric: "revenue" | "net_income" | "eps_diluted";
|
|
2236
|
+
unit: string | null;
|
|
2237
|
+
/** @description Ano fiscal */
|
|
2238
|
+
fy: number | null;
|
|
2239
|
+
/** @description Período fiscal (FY, Q1..Q4) */
|
|
2240
|
+
fp: string | null;
|
|
2241
|
+
period_start: string | null;
|
|
2242
|
+
period_end: string | null;
|
|
2243
|
+
value: number | null;
|
|
2244
|
+
/** @description Formulário de origem (10-K, 10-Q…) */
|
|
2245
|
+
form: string | null;
|
|
2246
|
+
filed: string | null;
|
|
2247
|
+
};
|
|
2248
|
+
UsQuote: {
|
|
2249
|
+
date: string;
|
|
2250
|
+
open: number | null;
|
|
2251
|
+
high: number | null;
|
|
2252
|
+
low: number | null;
|
|
2253
|
+
close: number | null;
|
|
2254
|
+
volume: number | null;
|
|
2255
|
+
};
|
|
2256
|
+
UsFiling: {
|
|
2257
|
+
accession: string;
|
|
2258
|
+
/** @description 10-K, 10-Q, 8-K, 20-F, 6-K, DEF 14A */
|
|
2259
|
+
form: string;
|
|
2260
|
+
filed_at: string;
|
|
2261
|
+
report_date: string | null;
|
|
2262
|
+
description: string | null;
|
|
2263
|
+
/** @description Documento principal no site da SEC (EDGAR) */
|
|
2264
|
+
url: string;
|
|
2053
2265
|
};
|
|
2054
2266
|
SearchResult: {
|
|
2055
2267
|
/** @enum {string} */
|
|
2056
|
-
kind: "stock" | "fii" | "index" | "bond" | "macro";
|
|
2268
|
+
kind: "stock" | "fii" | "index" | "bond" | "macro" | "crypto" | "us";
|
|
2057
2269
|
ticker: string;
|
|
2058
2270
|
title: string;
|
|
2059
2271
|
subtitle: string | null;
|
|
@@ -3427,7 +3639,7 @@ export interface operations {
|
|
|
3427
3639
|
query?: {
|
|
3428
3640
|
cursor?: string;
|
|
3429
3641
|
limit?: number;
|
|
3430
|
-
source?: "bcb_sgs" | "bcb_focus" | "ibge_sidra" | "fred" | "ipeadata" | "tesouro_direto";
|
|
3642
|
+
source?: "bcb_sgs" | "bcb_focus" | "ibge_sidra" | "fred" | "ipeadata" | "tesouro_direto" | "world_bank";
|
|
3431
3643
|
search?: string;
|
|
3432
3644
|
};
|
|
3433
3645
|
header?: never;
|
|
@@ -4275,6 +4487,106 @@ export interface operations {
|
|
|
4275
4487
|
};
|
|
4276
4488
|
};
|
|
4277
4489
|
};
|
|
4490
|
+
listCrypto: {
|
|
4491
|
+
parameters: {
|
|
4492
|
+
query?: {
|
|
4493
|
+
cursor?: string;
|
|
4494
|
+
limit?: number;
|
|
4495
|
+
search?: string;
|
|
4496
|
+
};
|
|
4497
|
+
header?: never;
|
|
4498
|
+
path?: never;
|
|
4499
|
+
cookie?: never;
|
|
4500
|
+
};
|
|
4501
|
+
requestBody?: never;
|
|
4502
|
+
responses: {
|
|
4503
|
+
/** @description Página de criptoativos */
|
|
4504
|
+
200: {
|
|
4505
|
+
headers: {
|
|
4506
|
+
[name: string]: unknown;
|
|
4507
|
+
};
|
|
4508
|
+
content: {
|
|
4509
|
+
"application/json": {
|
|
4510
|
+
data: components["schemas"]["CryptoAsset"][];
|
|
4511
|
+
meta: {
|
|
4512
|
+
next_cursor: string | null;
|
|
4513
|
+
/** @description Itens nesta página */
|
|
4514
|
+
count: number;
|
|
4515
|
+
};
|
|
4516
|
+
};
|
|
4517
|
+
};
|
|
4518
|
+
};
|
|
4519
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
4520
|
+
default: {
|
|
4521
|
+
headers: {
|
|
4522
|
+
[name: string]: unknown;
|
|
4523
|
+
};
|
|
4524
|
+
content: {
|
|
4525
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
4526
|
+
};
|
|
4527
|
+
};
|
|
4528
|
+
};
|
|
4529
|
+
};
|
|
4530
|
+
listCryptoLive: {
|
|
4531
|
+
parameters: {
|
|
4532
|
+
query?: never;
|
|
4533
|
+
header?: never;
|
|
4534
|
+
path?: never;
|
|
4535
|
+
cookie?: never;
|
|
4536
|
+
};
|
|
4537
|
+
requestBody?: never;
|
|
4538
|
+
responses: {
|
|
4539
|
+
/** @description Snapshot de cotações */
|
|
4540
|
+
200: {
|
|
4541
|
+
headers: {
|
|
4542
|
+
[name: string]: unknown;
|
|
4543
|
+
};
|
|
4544
|
+
content: {
|
|
4545
|
+
"application/json": components["schemas"]["CryptoLiveResponse"];
|
|
4546
|
+
};
|
|
4547
|
+
};
|
|
4548
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
4549
|
+
default: {
|
|
4550
|
+
headers: {
|
|
4551
|
+
[name: string]: unknown;
|
|
4552
|
+
};
|
|
4553
|
+
content: {
|
|
4554
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
4555
|
+
};
|
|
4556
|
+
};
|
|
4557
|
+
};
|
|
4558
|
+
};
|
|
4559
|
+
getCrypto: {
|
|
4560
|
+
parameters: {
|
|
4561
|
+
query?: never;
|
|
4562
|
+
header?: never;
|
|
4563
|
+
path: {
|
|
4564
|
+
symbol: string;
|
|
4565
|
+
};
|
|
4566
|
+
cookie?: never;
|
|
4567
|
+
};
|
|
4568
|
+
requestBody?: never;
|
|
4569
|
+
responses: {
|
|
4570
|
+
/** @description Criptoativo */
|
|
4571
|
+
200: {
|
|
4572
|
+
headers: {
|
|
4573
|
+
[name: string]: unknown;
|
|
4574
|
+
};
|
|
4575
|
+
content: {
|
|
4576
|
+
"application/json": components["schemas"]["CryptoAsset"];
|
|
4577
|
+
};
|
|
4578
|
+
};
|
|
4579
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
4580
|
+
default: {
|
|
4581
|
+
headers: {
|
|
4582
|
+
[name: string]: unknown;
|
|
4583
|
+
};
|
|
4584
|
+
content: {
|
|
4585
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
4586
|
+
};
|
|
4587
|
+
};
|
|
4588
|
+
};
|
|
4589
|
+
};
|
|
4278
4590
|
listCryptoQuotes: {
|
|
4279
4591
|
parameters: {
|
|
4280
4592
|
query?: {
|
|
@@ -4319,6 +4631,164 @@ export interface operations {
|
|
|
4319
4631
|
};
|
|
4320
4632
|
};
|
|
4321
4633
|
};
|
|
4634
|
+
listUsAssets: {
|
|
4635
|
+
parameters: {
|
|
4636
|
+
query?: {
|
|
4637
|
+
cursor?: string;
|
|
4638
|
+
limit?: number;
|
|
4639
|
+
search?: string;
|
|
4640
|
+
type?: "stock" | "etf";
|
|
4641
|
+
bdr?: string;
|
|
4642
|
+
};
|
|
4643
|
+
header?: never;
|
|
4644
|
+
path?: never;
|
|
4645
|
+
cookie?: never;
|
|
4646
|
+
};
|
|
4647
|
+
requestBody?: never;
|
|
4648
|
+
responses: {
|
|
4649
|
+
/** @description Página de ativos */
|
|
4650
|
+
200: {
|
|
4651
|
+
headers: {
|
|
4652
|
+
[name: string]: unknown;
|
|
4653
|
+
};
|
|
4654
|
+
content: {
|
|
4655
|
+
"application/json": {
|
|
4656
|
+
data: components["schemas"]["UsAsset"][];
|
|
4657
|
+
meta: {
|
|
4658
|
+
next_cursor: string | null;
|
|
4659
|
+
/** @description Itens nesta página */
|
|
4660
|
+
count: number;
|
|
4661
|
+
};
|
|
4662
|
+
};
|
|
4663
|
+
};
|
|
4664
|
+
};
|
|
4665
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
4666
|
+
default: {
|
|
4667
|
+
headers: {
|
|
4668
|
+
[name: string]: unknown;
|
|
4669
|
+
};
|
|
4670
|
+
content: {
|
|
4671
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
4672
|
+
};
|
|
4673
|
+
};
|
|
4674
|
+
};
|
|
4675
|
+
};
|
|
4676
|
+
getUsAsset: {
|
|
4677
|
+
parameters: {
|
|
4678
|
+
query?: never;
|
|
4679
|
+
header?: never;
|
|
4680
|
+
path: {
|
|
4681
|
+
ticker: string;
|
|
4682
|
+
};
|
|
4683
|
+
cookie?: never;
|
|
4684
|
+
};
|
|
4685
|
+
requestBody?: never;
|
|
4686
|
+
responses: {
|
|
4687
|
+
/** @description Ativo */
|
|
4688
|
+
200: {
|
|
4689
|
+
headers: {
|
|
4690
|
+
[name: string]: unknown;
|
|
4691
|
+
};
|
|
4692
|
+
content: {
|
|
4693
|
+
"application/json": components["schemas"]["UsAssetDetail"];
|
|
4694
|
+
};
|
|
4695
|
+
};
|
|
4696
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
4697
|
+
default: {
|
|
4698
|
+
headers: {
|
|
4699
|
+
[name: string]: unknown;
|
|
4700
|
+
};
|
|
4701
|
+
content: {
|
|
4702
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
4703
|
+
};
|
|
4704
|
+
};
|
|
4705
|
+
};
|
|
4706
|
+
};
|
|
4707
|
+
listUsAssetQuotes: {
|
|
4708
|
+
parameters: {
|
|
4709
|
+
query?: {
|
|
4710
|
+
cursor?: string;
|
|
4711
|
+
limit?: number;
|
|
4712
|
+
from?: string;
|
|
4713
|
+
to?: string;
|
|
4714
|
+
};
|
|
4715
|
+
header?: never;
|
|
4716
|
+
path: {
|
|
4717
|
+
ticker: string;
|
|
4718
|
+
};
|
|
4719
|
+
cookie?: never;
|
|
4720
|
+
};
|
|
4721
|
+
requestBody?: never;
|
|
4722
|
+
responses: {
|
|
4723
|
+
/** @description Página de cotações */
|
|
4724
|
+
200: {
|
|
4725
|
+
headers: {
|
|
4726
|
+
[name: string]: unknown;
|
|
4727
|
+
};
|
|
4728
|
+
content: {
|
|
4729
|
+
"application/json": {
|
|
4730
|
+
data: components["schemas"]["UsQuote"][];
|
|
4731
|
+
meta: {
|
|
4732
|
+
next_cursor: string | null;
|
|
4733
|
+
/** @description Itens nesta página */
|
|
4734
|
+
count: number;
|
|
4735
|
+
};
|
|
4736
|
+
};
|
|
4737
|
+
};
|
|
4738
|
+
};
|
|
4739
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
4740
|
+
default: {
|
|
4741
|
+
headers: {
|
|
4742
|
+
[name: string]: unknown;
|
|
4743
|
+
};
|
|
4744
|
+
content: {
|
|
4745
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
4746
|
+
};
|
|
4747
|
+
};
|
|
4748
|
+
};
|
|
4749
|
+
};
|
|
4750
|
+
listUsFilings: {
|
|
4751
|
+
parameters: {
|
|
4752
|
+
query?: {
|
|
4753
|
+
cursor?: string;
|
|
4754
|
+
limit?: number;
|
|
4755
|
+
form?: string;
|
|
4756
|
+
};
|
|
4757
|
+
header?: never;
|
|
4758
|
+
path: {
|
|
4759
|
+
ticker: string;
|
|
4760
|
+
};
|
|
4761
|
+
cookie?: never;
|
|
4762
|
+
};
|
|
4763
|
+
requestBody?: never;
|
|
4764
|
+
responses: {
|
|
4765
|
+
/** @description Página de filings */
|
|
4766
|
+
200: {
|
|
4767
|
+
headers: {
|
|
4768
|
+
[name: string]: unknown;
|
|
4769
|
+
};
|
|
4770
|
+
content: {
|
|
4771
|
+
"application/json": {
|
|
4772
|
+
data: components["schemas"]["UsFiling"][];
|
|
4773
|
+
meta: {
|
|
4774
|
+
next_cursor: string | null;
|
|
4775
|
+
/** @description Itens nesta página */
|
|
4776
|
+
count: number;
|
|
4777
|
+
};
|
|
4778
|
+
};
|
|
4779
|
+
};
|
|
4780
|
+
};
|
|
4781
|
+
/** @description Erro (RFC 9457 application/problem+json) */
|
|
4782
|
+
default: {
|
|
4783
|
+
headers: {
|
|
4784
|
+
[name: string]: unknown;
|
|
4785
|
+
};
|
|
4786
|
+
content: {
|
|
4787
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
4788
|
+
};
|
|
4789
|
+
};
|
|
4790
|
+
};
|
|
4791
|
+
};
|
|
4322
4792
|
search: {
|
|
4323
4793
|
parameters: {
|
|
4324
4794
|
query: {
|
package/dist/types.d.ts
CHANGED
|
@@ -85,6 +85,13 @@ export type TesouroBondsResponse = Ok<"listTesouroBonds">;
|
|
|
85
85
|
export type ExpectationsResponse = Ok<"getMarketExpectations">;
|
|
86
86
|
export type MacroGearsResponse = Ok<"getMacroGears">;
|
|
87
87
|
export type CryptoQuotesResponse = Ok<"listCryptoQuotes">;
|
|
88
|
+
export type CryptoListResponse = Ok<"listCrypto">;
|
|
89
|
+
export type CryptoAsset = Ok<"getCrypto">;
|
|
90
|
+
export type CryptoLiveResponse = Ok<"listCryptoLive">;
|
|
91
|
+
export type UsAssetsResponse = Ok<"listUsAssets">;
|
|
92
|
+
export type UsAssetDetail = Ok<"getUsAsset">;
|
|
93
|
+
export type UsQuotesResponse = Ok<"listUsAssetQuotes">;
|
|
94
|
+
export type UsFilingsResponse = Ok<"listUsFilings">;
|
|
88
95
|
export type SearchResponse = Ok<"search">;
|
|
89
96
|
export type OptionsChainResponse = Ok<"getOptionsChain">;
|
|
90
97
|
export type OptionExpiriesResponse = Ok<"listOptionExpiries">;
|
package/package.json
CHANGED