From 37da7c17f9ee42faa1f195f5f9fb168b64017480 Mon Sep 17 00:00:00 2001 From: justinpolygon <123573436+justinpolygon@users.noreply.github.com> Date: Wed, 19 Nov 2025 20:45:28 -0800 Subject: [PATCH 1/3] Updated with latest 2025-11-19 spec --- LICENSE | 2 +- ...n_ignore_v1indicators_ema_crypto_ticker.js | 15 - ...lygon_ignore_v1indicators_ema_fx_ticker.js | 15 - ..._ignore_v1indicators_ema_indices_ticker.js | 15 - ..._ignore_v1indicators_ema_options_ticker.js | 15 - ..._ignore_v1indicators_macd_crypto_ticker.js | 15 - ...ygon_ignore_v1indicators_macd_fx_ticker.js | 15 - ...ignore_v1indicators_macd_indices_ticker.js | 15 - ...ignore_v1indicators_macd_options_ticker.js | 15 - ...n_ignore_v1indicators_rsi_crypto_ticker.js | 15 - ...lygon_ignore_v1indicators_rsi_fx_ticker.js | 15 - ..._ignore_v1indicators_rsi_indices_ticker.js | 15 - ..._ignore_v1indicators_rsi_options_ticker.js | 15 - ...n_ignore_v1indicators_sma_crypto_ticker.js | 15 - ...lygon_ignore_v1indicators_sma_fx_ticker.js | 15 - ..._ignore_v1indicators_sma_indices_ticker.js | 15 - ..._ignore_v1indicators_sma_options_ticker.js | 15 - ...ygon_ignore_v2last_trade_options_ticker.js | 15 - .../x_polygon_ignore_v3quotes_fx_ticker.js | 15 - ..._polygon_ignore_v3quotes_options_ticker.js | 15 - ...x_polygon_ignore_v3trades_crypto_ticker.js | 15 - ..._polygon_ignore_v3trades_options_ticker.js | 15 - package-lock.json | 23 +- package.json | 19 +- scripts/pull_spec.js | 5 +- src/main.ts | 10 +- src/openapi.json | 14000 +++++++-- src/rest/.openapi-generator/FILES | 42 + src/rest/api.ts | 26238 ++++++++++------ src/rest/base.ts | 2 +- src/websockets/crypto/index.ts | 6 +- src/websockets/forex/index.ts | 2 +- src/websockets/futures/index.ts | 2 +- src/websockets/indices/index.ts | 2 +- src/websockets/options/index.ts | 2 +- src/websockets/stocks/index.ts | 2 +- 36 files changed, 29048 insertions(+), 11624 deletions(-) delete mode 100644 examples/rest/x_polygon_ignore_v1indicators_ema_crypto_ticker.js delete mode 100644 examples/rest/x_polygon_ignore_v1indicators_ema_fx_ticker.js delete mode 100644 examples/rest/x_polygon_ignore_v1indicators_ema_indices_ticker.js delete mode 100644 examples/rest/x_polygon_ignore_v1indicators_ema_options_ticker.js delete mode 100644 examples/rest/x_polygon_ignore_v1indicators_macd_crypto_ticker.js delete mode 100644 examples/rest/x_polygon_ignore_v1indicators_macd_fx_ticker.js delete mode 100644 examples/rest/x_polygon_ignore_v1indicators_macd_indices_ticker.js delete mode 100644 examples/rest/x_polygon_ignore_v1indicators_macd_options_ticker.js delete mode 100644 examples/rest/x_polygon_ignore_v1indicators_rsi_crypto_ticker.js delete mode 100644 examples/rest/x_polygon_ignore_v1indicators_rsi_fx_ticker.js delete mode 100644 examples/rest/x_polygon_ignore_v1indicators_rsi_indices_ticker.js delete mode 100644 examples/rest/x_polygon_ignore_v1indicators_rsi_options_ticker.js delete mode 100644 examples/rest/x_polygon_ignore_v1indicators_sma_crypto_ticker.js delete mode 100644 examples/rest/x_polygon_ignore_v1indicators_sma_fx_ticker.js delete mode 100644 examples/rest/x_polygon_ignore_v1indicators_sma_indices_ticker.js delete mode 100644 examples/rest/x_polygon_ignore_v1indicators_sma_options_ticker.js delete mode 100644 examples/rest/x_polygon_ignore_v2last_trade_options_ticker.js delete mode 100644 examples/rest/x_polygon_ignore_v3quotes_fx_ticker.js delete mode 100644 examples/rest/x_polygon_ignore_v3quotes_options_ticker.js delete mode 100644 examples/rest/x_polygon_ignore_v3trades_crypto_ticker.js delete mode 100644 examples/rest/x_polygon_ignore_v3trades_options_ticker.js diff --git a/LICENSE b/LICENSE index e1014b4..c71c556 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2019 Polygon.io +Copyright (c) 2019 Massive.com Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/examples/rest/x_polygon_ignore_v1indicators_ema_crypto_ticker.js b/examples/rest/x_polygon_ignore_v1indicators_ema_crypto_ticker.js deleted file mode 100644 index 48c713b..0000000 --- a/examples/rest/x_polygon_ignore_v1indicators_ema_crypto_ticker.js +++ /dev/null @@ -1,15 +0,0 @@ -import { restClient } from '@massive.com/client-js'; - -const apiKey = "GLOBAL_MASSIVE_API_KEY"; -const rest = restClient(apiKey, 'https://api.massive.com'); - -async function example_xMassiveIgnoreV1IndicatorsEmaCryptoTicker() { - try { - const response = await rest.xMassiveIgnoreV1IndicatorsEmaCryptoTicker(); - console.log('Response:', response); - } catch (e) { - console.error('An error happened:', e); - } -} - -example_xMassiveIgnoreV1IndicatorsEmaCryptoTicker(); \ No newline at end of file diff --git a/examples/rest/x_polygon_ignore_v1indicators_ema_fx_ticker.js b/examples/rest/x_polygon_ignore_v1indicators_ema_fx_ticker.js deleted file mode 100644 index 99894bf..0000000 --- a/examples/rest/x_polygon_ignore_v1indicators_ema_fx_ticker.js +++ /dev/null @@ -1,15 +0,0 @@ -import { restClient } from '@massive.com/client-js'; - -const apiKey = "GLOBAL_MASSIVE_API_KEY"; -const rest = restClient(apiKey, 'https://api.massive.com'); - -async function example_xMassiveIgnoreV1IndicatorsEmaFxTicker() { - try { - const response = await rest.xMassiveIgnoreV1IndicatorsEmaFxTicker(); - console.log('Response:', response); - } catch (e) { - console.error('An error happened:', e); - } -} - -example_xMassiveIgnoreV1IndicatorsEmaFxTicker(); \ No newline at end of file diff --git a/examples/rest/x_polygon_ignore_v1indicators_ema_indices_ticker.js b/examples/rest/x_polygon_ignore_v1indicators_ema_indices_ticker.js deleted file mode 100644 index 3d7a55d..0000000 --- a/examples/rest/x_polygon_ignore_v1indicators_ema_indices_ticker.js +++ /dev/null @@ -1,15 +0,0 @@ -import { restClient } from '@massive.com/client-js'; - -const apiKey = "GLOBAL_MASSIVE_API_KEY"; -const rest = restClient(apiKey, 'https://api.massive.com'); - -async function example_xMassiveIgnoreV1IndicatorsEmaIndicesTicker() { - try { - const response = await rest.xMassiveIgnoreV1IndicatorsEmaIndicesTicker(); - console.log('Response:', response); - } catch (e) { - console.error('An error happened:', e); - } -} - -example_xMassiveIgnoreV1IndicatorsEmaIndicesTicker(); \ No newline at end of file diff --git a/examples/rest/x_polygon_ignore_v1indicators_ema_options_ticker.js b/examples/rest/x_polygon_ignore_v1indicators_ema_options_ticker.js deleted file mode 100644 index 4fbbe2a..0000000 --- a/examples/rest/x_polygon_ignore_v1indicators_ema_options_ticker.js +++ /dev/null @@ -1,15 +0,0 @@ -import { restClient } from '@massive.com/client-js'; - -const apiKey = "GLOBAL_MASSIVE_API_KEY"; -const rest = restClient(apiKey, 'https://api.massive.com'); - -async function example_xMassiveIgnoreV1IndicatorsEmaOptionsTicker() { - try { - const response = await rest.xMassiveIgnoreV1IndicatorsEmaOptionsTicker(); - console.log('Response:', response); - } catch (e) { - console.error('An error happened:', e); - } -} - -example_xMassiveIgnoreV1IndicatorsEmaOptionsTicker(); \ No newline at end of file diff --git a/examples/rest/x_polygon_ignore_v1indicators_macd_crypto_ticker.js b/examples/rest/x_polygon_ignore_v1indicators_macd_crypto_ticker.js deleted file mode 100644 index 26031b1..0000000 --- a/examples/rest/x_polygon_ignore_v1indicators_macd_crypto_ticker.js +++ /dev/null @@ -1,15 +0,0 @@ -import { restClient } from '@massive.com/client-js'; - -const apiKey = "GLOBAL_MASSIVE_API_KEY"; -const rest = restClient(apiKey, 'https://api.massive.com'); - -async function example_xMassiveIgnoreV1IndicatorsMacdCryptoTicker() { - try { - const response = await rest.xMassiveIgnoreV1IndicatorsMacdCryptoTicker(); - console.log('Response:', response); - } catch (e) { - console.error('An error happened:', e); - } -} - -example_xMassiveIgnoreV1IndicatorsMacdCryptoTicker(); \ No newline at end of file diff --git a/examples/rest/x_polygon_ignore_v1indicators_macd_fx_ticker.js b/examples/rest/x_polygon_ignore_v1indicators_macd_fx_ticker.js deleted file mode 100644 index 0552041..0000000 --- a/examples/rest/x_polygon_ignore_v1indicators_macd_fx_ticker.js +++ /dev/null @@ -1,15 +0,0 @@ -import { restClient } from '@massive.com/client-js'; - -const apiKey = "GLOBAL_MASSIVE_API_KEY"; -const rest = restClient(apiKey, 'https://api.massive.com'); - -async function example_xMassiveIgnoreV1IndicatorsMacdFxTicker() { - try { - const response = await rest.xMassiveIgnoreV1IndicatorsMacdFxTicker(); - console.log('Response:', response); - } catch (e) { - console.error('An error happened:', e); - } -} - -example_xMassiveIgnoreV1IndicatorsMacdFxTicker(); \ No newline at end of file diff --git a/examples/rest/x_polygon_ignore_v1indicators_macd_indices_ticker.js b/examples/rest/x_polygon_ignore_v1indicators_macd_indices_ticker.js deleted file mode 100644 index bf1ffa3..0000000 --- a/examples/rest/x_polygon_ignore_v1indicators_macd_indices_ticker.js +++ /dev/null @@ -1,15 +0,0 @@ -import { restClient } from '@massive.com/client-js'; - -const apiKey = "GLOBAL_MASSIVE_API_KEY"; -const rest = restClient(apiKey, 'https://api.massive.com'); - -async function example_xMassiveIgnoreV1IndicatorsMacdIndicesTicker() { - try { - const response = await rest.xMassiveIgnoreV1IndicatorsMacdIndicesTicker(); - console.log('Response:', response); - } catch (e) { - console.error('An error happened:', e); - } -} - -example_xMassiveIgnoreV1IndicatorsMacdIndicesTicker(); \ No newline at end of file diff --git a/examples/rest/x_polygon_ignore_v1indicators_macd_options_ticker.js b/examples/rest/x_polygon_ignore_v1indicators_macd_options_ticker.js deleted file mode 100644 index 00b2491..0000000 --- a/examples/rest/x_polygon_ignore_v1indicators_macd_options_ticker.js +++ /dev/null @@ -1,15 +0,0 @@ -import { restClient } from '@massive.com/client-js'; - -const apiKey = "GLOBAL_MASSIVE_API_KEY"; -const rest = restClient(apiKey, 'https://api.massive.com'); - -async function example_xMassiveIgnoreV1IndicatorsMacdOptionsTicker() { - try { - const response = await rest.xMassiveIgnoreV1IndicatorsMacdOptionsTicker(); - console.log('Response:', response); - } catch (e) { - console.error('An error happened:', e); - } -} - -example_xMassiveIgnoreV1IndicatorsMacdOptionsTicker(); \ No newline at end of file diff --git a/examples/rest/x_polygon_ignore_v1indicators_rsi_crypto_ticker.js b/examples/rest/x_polygon_ignore_v1indicators_rsi_crypto_ticker.js deleted file mode 100644 index e013f2b..0000000 --- a/examples/rest/x_polygon_ignore_v1indicators_rsi_crypto_ticker.js +++ /dev/null @@ -1,15 +0,0 @@ -import { restClient } from '@massive.com/client-js'; - -const apiKey = "GLOBAL_MASSIVE_API_KEY"; -const rest = restClient(apiKey, 'https://api.massive.com'); - -async function example_xMassiveIgnoreV1IndicatorsRsiCryptoTicker() { - try { - const response = await rest.xMassiveIgnoreV1IndicatorsRsiCryptoTicker(); - console.log('Response:', response); - } catch (e) { - console.error('An error happened:', e); - } -} - -example_xMassiveIgnoreV1IndicatorsRsiCryptoTicker(); \ No newline at end of file diff --git a/examples/rest/x_polygon_ignore_v1indicators_rsi_fx_ticker.js b/examples/rest/x_polygon_ignore_v1indicators_rsi_fx_ticker.js deleted file mode 100644 index 6dec1b6..0000000 --- a/examples/rest/x_polygon_ignore_v1indicators_rsi_fx_ticker.js +++ /dev/null @@ -1,15 +0,0 @@ -import { restClient } from '@massive.com/client-js'; - -const apiKey = "GLOBAL_MASSIVE_API_KEY"; -const rest = restClient(apiKey, 'https://api.massive.com'); - -async function example_xMassiveIgnoreV1IndicatorsRsiFxTicker() { - try { - const response = await rest.xMassiveIgnoreV1IndicatorsRsiFxTicker(); - console.log('Response:', response); - } catch (e) { - console.error('An error happened:', e); - } -} - -example_xMassiveIgnoreV1IndicatorsRsiFxTicker(); \ No newline at end of file diff --git a/examples/rest/x_polygon_ignore_v1indicators_rsi_indices_ticker.js b/examples/rest/x_polygon_ignore_v1indicators_rsi_indices_ticker.js deleted file mode 100644 index 3a9103d..0000000 --- a/examples/rest/x_polygon_ignore_v1indicators_rsi_indices_ticker.js +++ /dev/null @@ -1,15 +0,0 @@ -import { restClient } from '@massive.com/client-js'; - -const apiKey = "GLOBAL_MASSIVE_API_KEY"; -const rest = restClient(apiKey, 'https://api.massive.com'); - -async function example_xMassiveIgnoreV1IndicatorsRsiIndicesTicker() { - try { - const response = await rest.xMassiveIgnoreV1IndicatorsRsiIndicesTicker(); - console.log('Response:', response); - } catch (e) { - console.error('An error happened:', e); - } -} - -example_xMassiveIgnoreV1IndicatorsRsiIndicesTicker(); \ No newline at end of file diff --git a/examples/rest/x_polygon_ignore_v1indicators_rsi_options_ticker.js b/examples/rest/x_polygon_ignore_v1indicators_rsi_options_ticker.js deleted file mode 100644 index b4cd5a1..0000000 --- a/examples/rest/x_polygon_ignore_v1indicators_rsi_options_ticker.js +++ /dev/null @@ -1,15 +0,0 @@ -import { restClient } from '@massive.com/client-js'; - -const apiKey = "GLOBAL_MASSIVE_API_KEY"; -const rest = restClient(apiKey, 'https://api.massive.com'); - -async function example_xMassiveIgnoreV1IndicatorsRsiOptionsTicker() { - try { - const response = await rest.xMassiveIgnoreV1IndicatorsRsiOptionsTicker(); - console.log('Response:', response); - } catch (e) { - console.error('An error happened:', e); - } -} - -example_xMassiveIgnoreV1IndicatorsRsiOptionsTicker(); \ No newline at end of file diff --git a/examples/rest/x_polygon_ignore_v1indicators_sma_crypto_ticker.js b/examples/rest/x_polygon_ignore_v1indicators_sma_crypto_ticker.js deleted file mode 100644 index 12198e6..0000000 --- a/examples/rest/x_polygon_ignore_v1indicators_sma_crypto_ticker.js +++ /dev/null @@ -1,15 +0,0 @@ -import { restClient } from '@massive.com/client-js'; - -const apiKey = "GLOBAL_MASSIVE_API_KEY"; -const rest = restClient(apiKey, 'https://api.massive.com'); - -async function example_xMassiveIgnoreV1IndicatorsSmaCryptoTicker() { - try { - const response = await rest.xMassiveIgnoreV1IndicatorsSmaCryptoTicker(); - console.log('Response:', response); - } catch (e) { - console.error('An error happened:', e); - } -} - -example_xMassiveIgnoreV1IndicatorsSmaCryptoTicker(); \ No newline at end of file diff --git a/examples/rest/x_polygon_ignore_v1indicators_sma_fx_ticker.js b/examples/rest/x_polygon_ignore_v1indicators_sma_fx_ticker.js deleted file mode 100644 index a8bdd09..0000000 --- a/examples/rest/x_polygon_ignore_v1indicators_sma_fx_ticker.js +++ /dev/null @@ -1,15 +0,0 @@ -import { restClient } from '@massive.com/client-js'; - -const apiKey = "GLOBAL_MASSIVE_API_KEY"; -const rest = restClient(apiKey, 'https://api.massive.com'); - -async function example_xMassiveIgnoreV1IndicatorsSmaFxTicker() { - try { - const response = await rest.xMassiveIgnoreV1IndicatorsSmaFxTicker(); - console.log('Response:', response); - } catch (e) { - console.error('An error happened:', e); - } -} - -example_xMassiveIgnoreV1IndicatorsSmaFxTicker(); \ No newline at end of file diff --git a/examples/rest/x_polygon_ignore_v1indicators_sma_indices_ticker.js b/examples/rest/x_polygon_ignore_v1indicators_sma_indices_ticker.js deleted file mode 100644 index b041761..0000000 --- a/examples/rest/x_polygon_ignore_v1indicators_sma_indices_ticker.js +++ /dev/null @@ -1,15 +0,0 @@ -import { restClient } from '@massive.com/client-js'; - -const apiKey = "GLOBAL_MASSIVE_API_KEY"; -const rest = restClient(apiKey, 'https://api.massive.com'); - -async function example_xMassiveIgnoreV1IndicatorsSmaIndicesTicker() { - try { - const response = await rest.xMassiveIgnoreV1IndicatorsSmaIndicesTicker(); - console.log('Response:', response); - } catch (e) { - console.error('An error happened:', e); - } -} - -example_xMassiveIgnoreV1IndicatorsSmaIndicesTicker(); \ No newline at end of file diff --git a/examples/rest/x_polygon_ignore_v1indicators_sma_options_ticker.js b/examples/rest/x_polygon_ignore_v1indicators_sma_options_ticker.js deleted file mode 100644 index 95f67ea..0000000 --- a/examples/rest/x_polygon_ignore_v1indicators_sma_options_ticker.js +++ /dev/null @@ -1,15 +0,0 @@ -import { restClient } from '@massive.com/client-js'; - -const apiKey = "GLOBAL_MASSIVE_API_KEY"; -const rest = restClient(apiKey, 'https://api.massive.com'); - -async function example_xMassiveIgnoreV1IndicatorsSmaOptionsTicker() { - try { - const response = await rest.xMassiveIgnoreV1IndicatorsSmaOptionsTicker(); - console.log('Response:', response); - } catch (e) { - console.error('An error happened:', e); - } -} - -example_xMassiveIgnoreV1IndicatorsSmaOptionsTicker(); \ No newline at end of file diff --git a/examples/rest/x_polygon_ignore_v2last_trade_options_ticker.js b/examples/rest/x_polygon_ignore_v2last_trade_options_ticker.js deleted file mode 100644 index 8230068..0000000 --- a/examples/rest/x_polygon_ignore_v2last_trade_options_ticker.js +++ /dev/null @@ -1,15 +0,0 @@ -import { restClient } from '@massive.com/client-js'; - -const apiKey = "GLOBAL_MASSIVE_API_KEY"; -const rest = restClient(apiKey, 'https://api.massive.com'); - -async function example_xMassiveIgnoreV2LastTradeOptionsTicker() { - try { - const response = await rest.xMassiveIgnoreV2LastTradeOptionsTicker(); - console.log('Response:', response); - } catch (e) { - console.error('An error happened:', e); - } -} - -example_xMassiveIgnoreV2LastTradeOptionsTicker(); \ No newline at end of file diff --git a/examples/rest/x_polygon_ignore_v3quotes_fx_ticker.js b/examples/rest/x_polygon_ignore_v3quotes_fx_ticker.js deleted file mode 100644 index 8f3d36e..0000000 --- a/examples/rest/x_polygon_ignore_v3quotes_fx_ticker.js +++ /dev/null @@ -1,15 +0,0 @@ -import { restClient } from '@massive.com/client-js'; - -const apiKey = "GLOBAL_MASSIVE_API_KEY"; -const rest = restClient(apiKey, 'https://api.massive.com'); - -async function example_xMassiveIgnoreV3QuotesFxTicker() { - try { - const response = await rest.xMassiveIgnoreV3QuotesFxTicker(); - console.log('Response:', response); - } catch (e) { - console.error('An error happened:', e); - } -} - -example_xMassiveIgnoreV3QuotesFxTicker(); \ No newline at end of file diff --git a/examples/rest/x_polygon_ignore_v3quotes_options_ticker.js b/examples/rest/x_polygon_ignore_v3quotes_options_ticker.js deleted file mode 100644 index 606e441..0000000 --- a/examples/rest/x_polygon_ignore_v3quotes_options_ticker.js +++ /dev/null @@ -1,15 +0,0 @@ -import { restClient } from '@massive.com/client-js'; - -const apiKey = "GLOBAL_MASSIVE_API_KEY"; -const rest = restClient(apiKey, 'https://api.massive.com'); - -async function example_xMassiveIgnoreV3QuotesOptionsTicker() { - try { - const response = await rest.xMassiveIgnoreV3QuotesOptionsTicker(); - console.log('Response:', response); - } catch (e) { - console.error('An error happened:', e); - } -} - -example_xMassiveIgnoreV3QuotesOptionsTicker(); \ No newline at end of file diff --git a/examples/rest/x_polygon_ignore_v3trades_crypto_ticker.js b/examples/rest/x_polygon_ignore_v3trades_crypto_ticker.js deleted file mode 100644 index 3d7299e..0000000 --- a/examples/rest/x_polygon_ignore_v3trades_crypto_ticker.js +++ /dev/null @@ -1,15 +0,0 @@ -import { restClient } from '@massive.com/client-js'; - -const apiKey = "GLOBAL_MASSIVE_API_KEY"; -const rest = restClient(apiKey, 'https://api.massive.com'); - -async function example_xMassiveIgnoreV3TradesCryptoTicker() { - try { - const response = await rest.xMassiveIgnoreV3TradesCryptoTicker(); - console.log('Response:', response); - } catch (e) { - console.error('An error happened:', e); - } -} - -example_xMassiveIgnoreV3TradesCryptoTicker(); \ No newline at end of file diff --git a/examples/rest/x_polygon_ignore_v3trades_options_ticker.js b/examples/rest/x_polygon_ignore_v3trades_options_ticker.js deleted file mode 100644 index fd46aa5..0000000 --- a/examples/rest/x_polygon_ignore_v3trades_options_ticker.js +++ /dev/null @@ -1,15 +0,0 @@ -import { restClient } from '@massive.com/client-js'; - -const apiKey = "GLOBAL_MASSIVE_API_KEY"; -const rest = restClient(apiKey, 'https://api.massive.com'); - -async function example_xMassiveIgnoreV3TradesOptionsTicker() { - try { - const response = await rest.xMassiveIgnoreV3TradesOptionsTicker(); - console.log('Response:', response); - } catch (e) { - console.error('An error happened:', e); - } -} - -example_xMassiveIgnoreV3TradesOptionsTicker(); \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index e56de1b..32ca9bb 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { - "name": "@polygon.io/client-js", - "version": "8.2.0", + "name": "@massive.com/client-js", + "version": "9.1.0", "lockfileVersion": 2, "requires": true, "packages": { "": { - "name": "@polygon.io/client-js", - "version": "8.2.0", + "name": "@massive.com/client-js", + "version": "9.1.0", "license": "MIT", "workspaces": [ "./dist/*", @@ -15,6 +15,7 @@ "dependencies": { "axios": "^1.8.4", "cross-fetch": "^3.1.4", + "openapi-generator-cli": "^1.0.0", "query-string": "^7.0.1", "websocket": "^1.0.34" }, @@ -4475,6 +4476,15 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/openapi-generator-cli": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/openapi-generator-cli/-/openapi-generator-cli-1.0.0.tgz", + "integrity": "sha512-gJ6YXQAkmoTYZ6kPG3rX9lHvVTh/bnWxfr6pDxjUfx+vSoE+JsuR4LDw+MrgH/7ezsJRFaljR66k0AlOXDW/eQ==", + "license": "ISC", + "bin": { + "openapi-generator-cli": "cli.js" + } + }, "node_modules/ora": { "version": "5.4.1", "resolved": "https://registry.npmjs.org/ora/-/ora-5.4.1.tgz", @@ -10133,6 +10143,11 @@ "is-wsl": "^3.1.0" } }, + "openapi-generator-cli": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/openapi-generator-cli/-/openapi-generator-cli-1.0.0.tgz", + "integrity": "sha512-gJ6YXQAkmoTYZ6kPG3rX9lHvVTh/bnWxfr6pDxjUfx+vSoE+JsuR4LDw+MrgH/7ezsJRFaljR66k0AlOXDW/eQ==" + }, "ora": { "version": "5.4.1", "resolved": "https://registry.npmjs.org/ora/-/ora-5.4.1.tgz", diff --git a/package.json b/package.json index a1af785..2535376 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { - "name": "@polygon.io/client-js", - "version": "8.2.0", - "description": "Isomorphic Javascript client for Polygon.io Stocks, Forex, and Crypto APIs", + "name": "@massive.com/client-js", + "version": "9.1.0", + "description": "Isomorphic Javascript client for Massive.com Stocks, Options, Indices, Futures, Forex, and Crypto APIs", "main": "dist/main.js", "types": "dist/main.d.ts", "type": "module", @@ -22,10 +22,10 @@ }, "repository": { "type": "git", - "url": "git+https://github.com/polygon-io/client-js.git" + "url": "git+https://github.com/massive-com/client-js.git" }, "keywords": [ - "polygon.io", + "massive.com", "stock api", "options api", "forex api", @@ -33,18 +33,19 @@ ], "contributors": [ { - "name": "Polygon Support", - "email": "support@polygon.io" + "name": "Massive Support", + "email": "support@massive.com" } ], "license": "MIT", "bugs": { - "url": "https://github.com/polygon-io/client-js/issues" + "url": "https://github.com/massive-com/client-js/issues" }, - "homepage": "https://github.com/polygon-io/client-js#readme", + "homepage": "https://github.com/massive-com/client-js#readme", "dependencies": { "axios": "^1.8.4", "cross-fetch": "^3.1.4", + "openapi-generator-cli": "^1.0.0", "query-string": "^7.0.1", "websocket": "^1.0.34" }, diff --git a/scripts/pull_spec.js b/scripts/pull_spec.js index 267c2fd..9f08657 100644 --- a/scripts/pull_spec.js +++ b/scripts/pull_spec.js @@ -29,7 +29,10 @@ const main = async () => { for (const [path, pathObj] of Object.entries(spec.paths)) { // Skip paths marked as drafts - if (pathObj["x-massive-draft"]) continue; + if (pathObj["x-polygon-draft"]) continue; + + // Skip paths starting with /v1/reference/ + if (path.startsWith('/v1/reference/')) continue; // Since all endpoints use GET, process the 'get' method const operation = pathObj.get; diff --git a/src/main.ts b/src/main.ts index 5b5ae31..e2c3f55 100644 --- a/src/main.ts +++ b/src/main.ts @@ -5,7 +5,7 @@ import axios from 'axios'; import websocketClient, { IWebsocketClient } from "./websockets/index.js"; import { DefaultApi, Configuration } from "./rest/index.js"; -export interface IPolygonClient { +export interface IMassiveClient { rest: DefaultApi; websockets: IWebsocketClient; } @@ -14,7 +14,7 @@ export const restClient = (apikey: string, restApiBase?: string, globalFetchOpti // This function creates a generated REST client using the DefaultApi from the generated REST code // Note: This does not include any custom interceptors or configurations const config = new Configuration({ apiKey: apikey }); - const SERVICE_BASE_URL = 'https://api.polygon.io'; // Fallback to default if not set + const SERVICE_BASE_URL = 'https://api.massive.com'; // Fallback to default if not set // Create a new axios instance to avoid global interceptor pollution const axiosInstance = axios.create(); @@ -31,14 +31,14 @@ export const restClient = (apikey: string, restApiBase?: string, globalFetchOpti return new DefaultApi(config, restApiBase || SERVICE_BASE_URL, axiosInstance); } -export const polygonClient = ( +export const MassiveClient = ( apiKey: string, restApiBase?: string, websocketApiBase?: string, globalFetchOptions?: { pagination: boolean } -): IPolygonClient => ({ +): IMassiveClient => ({ rest: restClient(apiKey, restApiBase, globalFetchOptions), websockets: websocketClient(apiKey, websocketApiBase), }); -export default polygonClient; +export default MassiveClient; diff --git a/src/openapi.json b/src/openapi.json index d31535d..3fe347f 100644 --- a/src/openapi.json +++ b/src/openapi.json @@ -21,7 +21,7 @@ } }, "AggregateLimitMax50000": { - "description": "Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000.\nRead more about how limit is used to calculate aggregate results in our article on\nAggregate Data API Improvements.\n", + "description": "Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000.\nRead more about how limit is used to calculate aggregate results in our article on\nAggregate Data API Improvements.\n", "example": 120, "in": "query", "name": "limit", @@ -283,7 +283,7 @@ "type": "boolean" }, "AskExchangeId": { - "description": "The ask exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The ask exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "AskPrice": { @@ -296,7 +296,7 @@ "type": "integer" }, "BidExchangeId": { - "description": "The bid exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The bid exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "BidPrice": { @@ -429,7 +429,7 @@ "type": "array" }, "type": { - "description": "The type or class of the security. (Full List of Ticker Types)", + "description": "The type or class of the security. (Full List of Ticker Types)", "type": "string" }, "updated": { @@ -447,7 +447,7 @@ "ConditionTypeMap": { "properties": { "condition": { - "description": "Polygon.io's mapping for condition codes. For more information, see our Trade Conditions Glossary.\n", + "description": "Massive.com's mapping for condition codes. For more information, see our Trade Conditions Glossary.\n", "type": "string" } }, @@ -456,7 +456,7 @@ "Conditions": { "description": "A list of condition codes.\n", "items": { - "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", + "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", "type": "integer" }, "type": "array" @@ -469,7 +469,7 @@ "items": { "properties": { "id": { - "description": "The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "market": { @@ -590,7 +590,7 @@ "c": { "description": "A list of condition codes.\n", "items": { - "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", + "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", "type": "integer" }, "type": "array" @@ -614,7 +614,7 @@ "type": "integer" }, "x": { - "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", + "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", "type": "integer" } }, @@ -647,13 +647,13 @@ "conditions": { "description": "A list of condition codes.\n", "items": { - "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", + "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", "type": "integer" }, "type": "array" }, "exchange": { - "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", + "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", "type": "integer" }, "price": { @@ -704,7 +704,7 @@ "c": { "description": "A list of condition codes.\n", "items": { - "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", + "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", "type": "integer" }, "type": "array" @@ -728,7 +728,7 @@ "type": "integer" }, "x": { - "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", + "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", "type": "integer" } }, @@ -765,7 +765,7 @@ "c": { "description": "A list of condition codes.\n", "items": { - "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", + "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", "type": "integer" }, "type": "array" @@ -789,7 +789,7 @@ "type": "integer" }, "x": { - "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", + "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", "type": "integer" } }, @@ -924,7 +924,7 @@ "type": "object" }, "fmv": { - "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", + "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", "format": "double", "type": "number" }, @@ -956,7 +956,7 @@ "type": "integer" }, "x": { - "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", + "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", "type": "integer" } }, @@ -1237,7 +1237,7 @@ "type": "object" }, "fmv": { - "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", + "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", "format": "double", "type": "number" }, @@ -1269,7 +1269,7 @@ "type": "integer" }, "x": { - "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", + "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", "type": "integer" } }, @@ -1422,7 +1422,7 @@ "c": { "description": "A list of condition codes.\n", "items": { - "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", + "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", "type": "integer" }, "type": "array" @@ -1446,7 +1446,7 @@ "type": "integer" }, "x": { - "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", + "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", "type": "integer" } }, @@ -1461,7 +1461,7 @@ "type": "object" }, "CryptoTradeExchange": { - "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", + "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", "type": "integer" }, "Date": { @@ -1480,7 +1480,7 @@ "items": { "properties": { "code": { - "description": "A unique identifier for the exchange internal to Polygon.io. This is not an industry code or ISO standard.", + "description": "A unique identifier for the exchange internal to Massive.com. This is not an industry code or ISO standard.", "type": "string" }, "id": { @@ -1513,7 +1513,7 @@ "type": "array" }, "ExchangeId": { - "description": "The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "Financial": { @@ -1999,7 +1999,7 @@ "type": "object" }, "Fmv": { - "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", + "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", "format": "double", "type": "number" }, @@ -2032,7 +2032,7 @@ "type": "number" }, "exchange": { - "description": "The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "timestamp": { @@ -2062,7 +2062,7 @@ "type": "object" }, "ForexExchangeId": { - "description": "The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "ForexGroupedResults": { @@ -2167,7 +2167,7 @@ "type": "integer" }, "x": { - "description": "The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" } }, @@ -2206,7 +2206,7 @@ "type": "number" }, "exchange": { - "description": "The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "timestamp": { @@ -2413,7 +2413,7 @@ "type": "object" }, "fmv": { - "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", + "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", "format": "double", "type": "number" }, @@ -2609,7 +2609,7 @@ "type": "object" }, "fmv": { - "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", + "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", "format": "double", "type": "number" }, @@ -2860,7 +2860,7 @@ "type": "object" }, "Indicators": { - "description": "The indicators. For more information, see our glossary of [Conditions and\nIndicators](https://polygon.io/glossary/us/stocks/conditions-indicators).\n", + "description": "The indicators. For more information, see our glossary of [Conditions and\nIndicators](https://massive.com/glossary/us/stocks/conditions-indicators).\n", "items": { "description": "The indicator code.\n", "type": "integer" @@ -3922,7 +3922,7 @@ "type": "object" }, "fmv": { - "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", + "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", "format": "double", "type": "number" }, @@ -3989,7 +3989,7 @@ "type": "integer" }, "x": { - "description": "The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" } }, @@ -4193,7 +4193,7 @@ "type": "object" }, "fmv": { - "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", + "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", "format": "double", "type": "number" }, @@ -4260,7 +4260,7 @@ "type": "integer" }, "x": { - "description": "The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" } }, @@ -4555,19 +4555,19 @@ "type": "integer" }, "X": { - "description": "The ask exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The ask exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "c": { "description": "A list of condition codes.\n", "items": { - "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", + "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", "type": "integer" }, "type": "array" }, "i": { - "description": "The indicators. For more information, see our glossary of [Conditions and\nIndicators](https://polygon.io/glossary/us/stocks/conditions-indicators).\n", + "description": "The indicators. For more information, see our glossary of [Conditions and\nIndicators](https://massive.com/glossary/us/stocks/conditions-indicators).\n", "items": { "description": "The indicator code.\n", "type": "integer" @@ -4584,7 +4584,7 @@ "type": "integer" }, "x": { - "description": "The bid exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The bid exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "z": { @@ -4657,19 +4657,19 @@ "type": "integer" }, "X": { - "description": "The ask exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The ask exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "c": { "description": "A list of condition codes.\n", "items": { - "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", + "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", "type": "integer" }, "type": "array" }, "i": { - "description": "The indicators. For more information, see our glossary of [Conditions and\nIndicators](https://polygon.io/glossary/us/stocks/conditions-indicators).\n", + "description": "The indicators. For more information, see our glossary of [Conditions and\nIndicators](https://massive.com/glossary/us/stocks/conditions-indicators).\n", "items": { "description": "The indicator code.\n", "type": "integer" @@ -4686,7 +4686,7 @@ "type": "integer" }, "x": { - "description": "The bid exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The bid exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "z": { @@ -4754,7 +4754,7 @@ "c": { "description": "A list of condition codes.\n", "items": { - "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", + "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", "type": "integer" }, "type": "array" @@ -4782,7 +4782,7 @@ "type": "number" }, "x": { - "description": "The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "z": { @@ -4847,7 +4847,7 @@ "c": { "description": "A list of condition codes.\n", "items": { - "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", + "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", "type": "integer" }, "type": "array" @@ -4875,7 +4875,7 @@ "type": "number" }, "x": { - "description": "The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "z": { @@ -6046,6 +6046,14 @@ "type": "string" } }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "date.any_of", + "schema": { + "type": "string" + } + }, { "description": "Filter greater than the value.", "in": "query", @@ -6428,7 +6436,7 @@ } }, { - "description": "The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system.", + "description": "The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system. Value must be an integer timestamp in seconds or formatted 'yyyy-mm-dd'.", "in": "query", "name": "last_updated", "schema": { @@ -6436,7 +6444,7 @@ } }, { - "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer timestamp in seconds or formatted 'yyyy-mm-dd'.", "in": "query", "name": "last_updated.any_of", "schema": { @@ -6444,7 +6452,7 @@ } }, { - "description": "Filter greater than the value.", + "description": "Filter greater than the value. Value must be an integer timestamp in seconds or formatted 'yyyy-mm-dd'.", "in": "query", "name": "last_updated.gt", "schema": { @@ -6452,7 +6460,7 @@ } }, { - "description": "Filter greater than or equal to the value.", + "description": "Filter greater than or equal to the value. Value must be an integer timestamp in seconds or formatted 'yyyy-mm-dd'.", "in": "query", "name": "last_updated.gte", "schema": { @@ -6460,7 +6468,7 @@ } }, { - "description": "Filter less than the value.", + "description": "Filter less than the value. Value must be an integer timestamp in seconds or formatted 'yyyy-mm-dd'.", "in": "query", "name": "last_updated.lt", "schema": { @@ -6468,7 +6476,7 @@ } }, { - "description": "Filter less than or equal to the value.", + "description": "Filter less than or equal to the value. Value must be an integer timestamp in seconds or formatted 'yyyy-mm-dd'.", "in": "query", "name": "last_updated.lte", "schema": { @@ -6742,11 +6750,11 @@ } }, { - "description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'desc' if not specified.", + "description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'last_updated' if not specified. The sort order defaults to 'desc' if not specified.", "in": "query", "name": "sort", "schema": { - "default": "date.desc", + "default": "last_updated.desc", "type": "string" } } @@ -6865,6 +6873,7 @@ }, "last_updated": { "description": "The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system.", + "format": "date-time", "type": "string" }, "notes": { @@ -8274,14 +8283,6 @@ "type": "integer" } }, - { - "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer.", - "in": "query", - "name": "importance.any_of", - "schema": { - "type": "string" - } - }, { "description": "Filter greater than the value. Value must be an integer.", "in": "query", @@ -8319,7 +8320,7 @@ } }, { - "description": "The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system.", + "description": "The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system. Value must be an integer timestamp in seconds or formatted 'yyyy-mm-dd'.", "in": "query", "name": "last_updated", "schema": { @@ -8327,15 +8328,7 @@ } }, { - "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", - "in": "query", - "name": "last_updated.any_of", - "schema": { - "type": "string" - } - }, - { - "description": "Filter greater than the value.", + "description": "Filter greater than the value. Value must be an integer timestamp in seconds or formatted 'yyyy-mm-dd'.", "in": "query", "name": "last_updated.gt", "schema": { @@ -8343,7 +8336,7 @@ } }, { - "description": "Filter greater than or equal to the value.", + "description": "Filter greater than or equal to the value. Value must be an integer timestamp in seconds or formatted 'yyyy-mm-dd'.", "in": "query", "name": "last_updated.gte", "schema": { @@ -8351,7 +8344,7 @@ } }, { - "description": "Filter less than the value.", + "description": "Filter less than the value. Value must be an integer timestamp in seconds or formatted 'yyyy-mm-dd'.", "in": "query", "name": "last_updated.lt", "schema": { @@ -8359,7 +8352,7 @@ } }, { - "description": "Filter less than or equal to the value.", + "description": "Filter less than or equal to the value. Value must be an integer timestamp in seconds or formatted 'yyyy-mm-dd'.", "in": "query", "name": "last_updated.lte", "schema": { @@ -8618,11 +8611,11 @@ } }, { - "description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'desc' if not specified.", + "description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'last_updated' if not specified. The sort order defaults to 'desc' if not specified.", "in": "query", "name": "sort", "schema": { - "default": "date.desc", + "default": "last_updated.desc", "type": "string" } } @@ -8679,7 +8672,7 @@ "properties": { "adjusted_price_target": { "description": "The current price target adjusted for stock splits and dividends.", - "format": "float", + "format": "double", "type": "number" }, "analyst": { @@ -8729,6 +8722,7 @@ }, "last_updated": { "description": "The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system.", + "format": "date-time", "type": "string" }, "notes": { @@ -8737,12 +8731,12 @@ }, "previous_adjusted_price_target": { "description": "The previous price target adjusted for stock splits and dividends.", - "format": "float", + "format": "double", "type": "number" }, "previous_price_target": { "description": "The previous price target set by the analyst.", - "format": "float", + "format": "double", "type": "number" }, "previous_rating": { @@ -8751,12 +8745,12 @@ }, "price_percent_change": { "description": "The percentage change in price target if price target and previous price target exists", - "format": "float", + "format": "double", "type": "number" }, "price_target": { "description": "The current price target set by the analyst.", - "format": "float", + "format": "double", "type": "number" }, "price_target_action": { @@ -8841,15 +8835,103 @@ ] } }, - "/fed/v1/inflation": { + "/benzinga/v2/news": { "get": { - "description": "A table tracking inflation and price indices, including Consumer Price Index (CPI) and Personal Consumption Expenditures (PCE) metrics over time.", - "operationId": "get_fed_v1_inflation", + "description": "A comprehensive news article database from Benzinga, containing detailed information about financial news articles including metadata, content, and associated financial information.", + "operationId": "get_benzinga_v2_news", "parameters": [ { - "description": "Calendar date of the observation (YYYY‑MM‑DD).", + "description": "The timestamp (formatted as an ISO 8601 timestamp) when the news article was originally published. Value must be an integer timestamp in seconds or formatted 'yyyy-mm-dd'.", "in": "query", - "name": "date", + "name": "published", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value. Value must be an integer timestamp in seconds or formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "published.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be an integer timestamp in seconds or formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "published.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value. Value must be an integer timestamp in seconds or formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "published.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value. Value must be an integer timestamp in seconds or formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "published.lte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter for arrays that contain the value.", + "in": "query", + "name": "channels", + "schema": { + "type": "string" + } + }, + { + "description": "Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "channels.all_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "channels.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter for arrays that contain the value.", + "in": "query", + "name": "tags", + "schema": { + "type": "string" + } + }, + { + "description": "Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "tags.all_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "tags.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "The name of the journalist or entity that authored the news article.", + "in": "query", + "name": "author", "schema": { "type": "string" } @@ -8857,7 +8939,7 @@ { "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", "in": "query", - "name": "date.any_of", + "name": "author.any_of", "schema": { "type": "string" } @@ -8865,7 +8947,7 @@ { "description": "Filter greater than the value.", "in": "query", - "name": "date.gt", + "name": "author.gt", "schema": { "type": "string" } @@ -8873,7 +8955,7 @@ { "description": "Filter greater than or equal to the value.", "in": "query", - "name": "date.gte", + "name": "author.gte", "schema": { "type": "string" } @@ -8881,7 +8963,7 @@ { "description": "Filter less than the value.", "in": "query", - "name": "date.lt", + "name": "author.lt", "schema": { "type": "string" } @@ -8889,7 +8971,55 @@ { "description": "Filter less than or equal to the value.", "in": "query", - "name": "date.lte", + "name": "author.lte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter for arrays that contain the value.", + "in": "query", + "name": "stocks", + "schema": { + "type": "string" + } + }, + { + "description": "Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "stocks.all_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "stocks.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter for arrays that contain the value.", + "in": "query", + "name": "tickers", + "schema": { + "type": "string" + } + }, + { + "description": "Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "tickers.all_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "tickers.any_of", "schema": { "type": "string" } @@ -8906,11 +9036,11 @@ } }, { - "description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'asc' if not specified.", + "description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'published' if not specified. The sort order defaults to 'desc' if not specified.", "in": "query", "name": "sort", "schema": { - "default": "date.asc", + "default": "published.desc", "type": "string" } } @@ -8924,13 +9054,32 @@ "request_id": 1, "results": [ { - "cpi": 310.45, - "cpi_core": 320.1, - "cpi_year_over_year": 3.18, - "date": "2025-06-01", - "pce": 132.73, - "pce_core": 131.9, - "pce_spending": 20345.6 + "author": "Adam Eckert", + "benzinga_id": 39046904, + "body": "

CAVA Group Inc (NYSE:CAVA) reported financial results for the first quarter of fiscal 2024 after market close on Tuesday. Here’s a look at the key metrics from the quarter.

", + "channels": [ + "earnings", + "news", + "restaurants", + "after-hours center", + "movers" + ], + "images": [ + "https://cdn.benzinga.com/files/imagecache/250x187xUP/images/story/2024/05/28/CAVA-group.jpeg", + "https://cdn.benzinga.com/files/imagecache/1024x768xUP/images/story/2024/05/28/CAVA-group.jpeg", + "https://cdn.benzinga.com/files/imagecache/2048x1536xUP/images/story/2024/05/28/CAVA-group.jpeg" + ], + "last_updated": "2024-05-28T20:27:42Z", + "published": "2024-05-28T20:27:41Z", + "tags": [ + "why it's moving" + ], + "teaser": "Cava's first-quarter revenue increased 30.3% year-over-year to $256.3 million, which beat the consensus estimate of $245.935 million, according to Benzinga Pro.", + "tickers": [ + "CAVA" + ], + "title": "Cava Group Q1 Earnings: Revenue Beat, EPS Beat, Guidance Raise, Continued Investments In Scalable Infrastructure And More", + "url": "https://www.benzinga.com/news/earnings/24/05/39046904/cava-group-q1-earnings-revenue-beat-eps-beat-guidance-raise-continued-investments-in-scalable-infra" } ], "status": "OK" @@ -8949,41 +9098,78 @@ "description": "The results for this request.", "items": { "properties": { - "cpi": { - "description": "Consumer Price Index (CPI) for All Urban Consumers — a standard measure of headline inflation based on a fixed basket of goods and services, not seasonally adjusted.", - "format": "float", - "type": "number" + "author": { + "description": "The name of the journalist or entity that authored the news article.", + "type": "string" }, - "cpi_core": { - "description": "Core Consumer Price Index — the CPI excluding food and energy, used to understand underlying inflation trends without short-term volatility.", - "format": "float", - "type": "number" + "benzinga_id": { + "description": "The identifer used by Benzinga for this record.", + "format": "int64", + "type": "integer" }, - "cpi_year_over_year": { - "description": "Year-over-year percentage change in the headline CPI — the most commonly cited inflation rate in public discourse and economic policy.", - "format": "float", - "type": "number" + "body": { + "description": "The full text content of the news article.", + "type": "string" }, - "date": { - "description": "Calendar date of the observation (YYYY‑MM‑DD).", + "channels": { + "description": "A list of categories or topics that the article belongs to (e.g., 'News', 'Price Target').", + "items": { + "type": "string" + }, + "type": "array" + }, + "images": { + "description": "A list of images associated with the article.", + "items": { + "type": "string" + }, + "type": "array" + }, + "last_updated": { + "description": "The timestamp (formatted as an ISO 8601 timestamp) when the news article was last updated in the system.", + "format": "date-time", "type": "string" }, - "pce": { - "description": "Personal Consumption Expenditures (PCE) Price Index — a broader measure of inflation used by the Federal Reserve, reflecting actual consumer spending patterns and updated basket weights.", - "format": "float", - "type": "number" + "published": { + "description": "The timestamp (formatted as an ISO 8601 timestamp) when the news article was originally published.", + "format": "date-time", + "type": "string" }, - "pce_core": { - "description": "Core PCE Price Index — excludes food and energy prices from the PCE index, and is the Fed's preferred measure of underlying inflation.", - "format": "float", - "type": "number" + "tags": { + "description": "A list of tags that describe the themes or content of the article.", + "items": { + "type": "string" + }, + "type": "array" }, - "pce_spending": { - "description": "Nominal Personal Consumption Expenditures — total dollar value of consumer spending in the U.S. economy, reported in billions of dollars and not adjusted for inflation.", - "format": "float", - "type": "number" + "teaser": { + "description": "A short summary or lead-in to the news article's content.", + "type": "string" + }, + "tickers": { + "description": "A list of stock or crypto tickers mentioned in the article.", + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "The headline of the news article.", + "type": "string" + }, + "url": { + "description": "The direct link to the source of the news article.", + "type": "string" } }, + "required": [ + "benzinga_id", + "author", + "published", + "last_updated", + "title", + "url" + ], "type": "object" }, "type": "array" @@ -9045,78 +9231,21 @@ ] } }, - "/fed/v1/inflation-expectations": { + "/crypto/v1/exchanges": { "get": { - "description": "A table tracking inflation expectations from both market-based and economic model perspectives across different time horizons.", - "operationId": "get_fed_v1_inflation-expectations", + "description": "Global cryptocurrency exchanges and digital asset trading platforms, including major centralized exchanges (Coinbase, Binance, Bitfinex, etc.) that facilitate trading of cryptocurrencies and digital tokens worldwide.", + "operationId": "get_crypto_v1_exchanges", "parameters": [ { - "description": "Calendar date of the observation (YYYY‑MM‑DD).", - "in": "query", - "name": "date", - "schema": { - "type": "string" - } - }, - { - "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", - "in": "query", - "name": "date.any_of", - "schema": { - "type": "string" - } - }, - { - "description": "Filter greater than the value.", - "in": "query", - "name": "date.gt", - "schema": { - "type": "string" - } - }, - { - "description": "Filter greater than or equal to the value.", - "in": "query", - "name": "date.gte", - "schema": { - "type": "string" - } - }, - { - "description": "Filter less than the value.", - "in": "query", - "name": "date.lt", - "schema": { - "type": "string" - } - }, - { - "description": "Filter less than or equal to the value.", - "in": "query", - "name": "date.lte", - "schema": { - "type": "string" - } - }, - { - "description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.", + "description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '999'.", "in": "query", "name": "limit", "schema": { "default": 100, - "maximum": 50001, + "maximum": 1000, "minimum": 1, "type": "integer" } - }, - { - "description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'asc' if not specified.", - "in": "query", - "name": "sort", - "schema": { - "default": "date.asc", - "type": "string" - } } ], "responses": { @@ -9124,18 +9253,20 @@ "content": { "application/json": { "example": { - "count": 1, + "count": 2, "request_id": 1, "results": [ { - "date": "2025-06-17", - "forward_years_5_to_10": 2.6, - "market_10_year": 2.36, - "market_5_year": 2.12, - "model_10_year": 2.95, - "model_1_year": 2.85, - "model_30_year": 3, - "model_5_year": 2.91 + "id": "1", + "name": "Coinbase", + "type": "exchange", + "url": "https://www.coinbase.com" + }, + { + "id": "10", + "name": "Binance", + "type": "exchange", + "url": "https://www.binance.us/" } ], "status": "OK" @@ -9154,46 +9285,28 @@ "description": "The results for this request.", "items": { "properties": { - "date": { - "description": "Calendar date of the observation (YYYY‑MM‑DD).", + "id": { + "description": "Numeric identifier for the cryptocurrency exchange or trading platform.", "type": "string" }, - "forward_years_5_to_10": { - "description": "5-Year, 5-Year Forward Inflation Expectation Rate — the market's expectation of average annual inflation for the 5-year period beginning 5 years from now, based on the spread between forward nominal and real yields.", - "format": "float", - "type": "number" - }, - "market_10_year": { - "description": "10-Year Breakeven Inflation Rate — the market's expectation of average annual inflation over the next 10 years, based on the spread between 10-year nominal Treasury yields and 10-year TIPS yields.", - "format": "float", - "type": "number" - }, - "market_5_year": { - "description": "5-Year Breakeven Inflation Rate — the market's expectation of average annual inflation over the next 5 years, based on the spread between 5-year nominal Treasury yields and 5-year TIPS yields.", - "format": "float", - "type": "number" - }, - "model_10_year": { - "description": "The Cleveland Fed’s 10-year inflation expectations data estimated expected inflation, risk premiums, and the real interest rate using a model based on Treasury yields, inflation data, swaps, and surveys.", - "format": "float", - "type": "number" - }, - "model_1_year": { - "description": "The Cleveland Fed’s 1-year inflation expectations data estimated expected inflation, risk premiums, and the real interest rate using a model based on Treasury yields, inflation data, swaps, and surveys.", - "format": "float", - "type": "number" + "name": { + "description": "Full official name of the cryptocurrency exchange or digital asset trading platform.", + "type": "string" }, - "model_30_year": { - "description": "The Cleveland Fed’s 30-year inflation expectations data estimated expected inflation, risk premiums, and the real interest rate using a model based on Treasury yields, inflation data, swaps, and surveys.", - "format": "float", - "type": "number" + "type": { + "description": "Type of crypto venue - 'exchange' for cryptocurrency exchanges and digital asset trading platforms.", + "type": "string" }, - "model_5_year": { - "description": "The Cleveland Fed’s 5-year inflation expectations data estimated expected inflation, risk premiums, and the real interest rate using a model based on Treasury yields, inflation data, swaps, and surveys.", - "format": "float", - "type": "number" + "url": { + "description": "Official website URL of the cryptocurrency exchange.", + "type": "string" } }, + "required": [ + "id", + "type", + "name" + ], "type": "object" }, "type": "array" @@ -9255,15 +9368,15 @@ ] } }, - "/fed/v1/treasury-yields": { + "/etf-global/v1/analytics": { "get": { - "description": "A record of U.S. Treasury bond yields across various maturity periods, tracking historical interest rates from short-term to long-term government securities.", - "operationId": "get_fed_v1_treasury-yields", + "description": "ETF Global analytics data containing risk scores, reward metrics, and quantitative analysis for ETF composite tickers.", + "operationId": "get_etf-global_v1_analytics", "parameters": [ { - "description": "Calendar date of the yield observation (YYYY-MM-DD).", + "description": "The stock ticker symbol used to identify this ETF product on exchanges.", "in": "query", - "name": "date", + "name": "composite_ticker", "schema": { "type": "string" } @@ -9271,7 +9384,7 @@ { "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", "in": "query", - "name": "date.any_of", + "name": "composite_ticker.any_of", "schema": { "type": "string" } @@ -9279,7 +9392,7 @@ { "description": "Filter greater than the value.", "in": "query", - "name": "date.gt", + "name": "composite_ticker.gt", "schema": { "type": "string" } @@ -9287,7 +9400,7 @@ { "description": "Filter greater than or equal to the value.", "in": "query", - "name": "date.gte", + "name": "composite_ticker.gte", "schema": { "type": "string" } @@ -9295,7 +9408,7 @@ { "description": "Filter less than the value.", "in": "query", - "name": "date.lt", + "name": "composite_ticker.lt", "schema": { "type": "string" } @@ -9303,506 +9416,561 @@ { "description": "Filter less than or equal to the value.", "in": "query", - "name": "date.lte", + "name": "composite_ticker.lte", "schema": { "type": "string" } }, { - "description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.", + "description": "The date showing when ETF Global received and processed the data. Value must be formatted 'yyyy-mm-dd'.", "in": "query", - "name": "limit", + "name": "processed_date", "schema": { - "default": 100, - "maximum": 50001, - "minimum": 1, - "type": "integer" + "type": "string" } }, { - "description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'asc' if not specified.", + "description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.", "in": "query", - "name": "sort", + "name": "processed_date.gt", "schema": { - "default": "date.asc", "type": "string" } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "example": { - "count": 1, - "request_id": 1, - "results": [ - { - "date": "1962-01-02", - "yield_10_year": 4.06, - "yield_1_year": 3.22, - "yield_5_year": 3.88 - } - ], - "status": "OK" - }, - "schema": { - "properties": { - "next_url": { - "description": "If present, this value can be used to fetch the next page.", - "type": "string" - }, - "request_id": { - "description": "A request id assigned by the server.", - "type": "string" - }, - "results": { - "description": "The results for this request.", - "items": { - "properties": { - "date": { - "description": "Calendar date of the yield observation (YYYY-MM-DD).", - "type": "string" - }, - "yield_10_year": { - "description": "Market Yield on U.S. Treasury Securities at 10-Year Constant Maturity, Quoted on an Investment Basis", - "format": "float", - "type": "number" - }, - "yield_1_month": { - "description": "Market Yield on U.S. Treasury Securities at 1-Month Constant Maturity, Quoted on an Investment Basis", - "format": "float", - "type": "number" - }, - "yield_1_year": { - "description": "Market Yield on U.S. Treasury Securities at 1-Year Constant Maturity, Quoted on an Investment Basis", - "format": "float", - "type": "number" - }, - "yield_20_year": { - "description": "Market Yield on U.S. Treasury Securities at 20-Year Constant Maturity, Quoted on an Investment Basis", - "format": "float", - "type": "number" - }, - "yield_2_year": { - "description": "Market Yield on U.S. Treasury Securities at 2-Year Constant Maturity, Quoted on an Investment Basis", - "format": "float", - "type": "number" - }, - "yield_30_year": { - "description": "Market Yield on U.S. Treasury Securities at 30-Year Constant Maturity, Quoted on an Investment Basis", - "format": "float", - "type": "number" - }, - "yield_3_month": { - "description": "Market Yield on U.S. Treasury Securities at 3-Month Constant Maturity, Quoted on an Investment Basis", - "format": "float", - "type": "number" - }, - "yield_3_year": { - "description": "Market Yield on U.S. Treasury Securities at 3-Year Constant Maturity, Quoted on an Investment Basis", - "format": "float", - "type": "number" - }, - "yield_5_year": { - "description": "Market Yield on U.S. Treasury Securities at 5-Year Constant Maturity, Quoted on an Investment Basis", - "format": "float", - "type": "number" - }, - "yield_6_month": { - "description": "Market Yield on U.S. Treasury Securities at 6-Month Constant Maturity, Quoted on an Investment Basis", - "format": "float", - "type": "number" - }, - "yield_7_year": { - "description": "Market Yield on U.S. Treasury Securities at 7-Year Constant Maturity, Quoted on an Investment Basis", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "type": "array" - }, - "status": { - "description": "The status of this request's response.", - "enum": [ - "OK" - ], - "type": "string" - } - }, - "required": [ - "status", - "request_id", - "results" - ], - "type": "object" - } - } - }, - "description": "A list of results." }, - "400": { - "content": { - "application/json": { - "schema": { - "properties": { - "error": { - "description": "A message describing the source of the error.", - "type": "string" - }, - "request_id": { - "description": "A request id assigned by the server.", - "type": "string" - }, - "status": { - "description": "The status of this request's response.", - "enum": [ - "ERROR" - ], - "type": "string" - } - }, - "required": [ - "status", - "request_id", - "error" - ], - "type": "object" - } - } - }, - "description": "An error message." - } - }, - "tags": [ - "default" - ] - } - }, - "/futures/vX/aggs/{ticker}": { - "get": { - "description": "Get aggregates for a contract in a given time range.", - "operationId": "GetFuturesAggregates", - "parameters": [ { - "description": "The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract).", - "example": "GCJ5", - "in": "path", - "name": "ticker", - "required": true, + "description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "processed_date.gte", "schema": { "type": "string" - }, - "x-polygon-go-id": "Ticker" + } }, { - "description": "This sets the size of the aggregate windows. It accepts custom values that specify the granularity and the duration of the window.\nFor example: 15mins, 30secs, 12hours, or 7days.\nThere are maximum allowable candle sizes. For example, you can request \"1min\" to \"59mins\", but after that you will need to use \"1hr\". If you make a request for a candle size that is not supported, we will return a 400 \"Bad Request - resolution value is not allowed.\"", - "example": "1min", + "description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'.", "in": "query", - "name": "resolution", + "name": "processed_date.lt", "schema": { - "default": "1day", "type": "string" } }, { - "description": "This sets the range of time for your results. The window_start timestamp you choose specifies the starting edge of the candle or candles you want returned. If no value is set, you will get the oldest or newest available candles, depending on your sort order.\nYou can combine window_start to form a time range, for example: window_start.gte=2024-01-01&window_start.lte=2024-01-31", + "description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", "in": "query", - "name": "window_start", + "name": "processed_date.lte", "schema": { "type": "string" - }, - "x-polygon-filter-field": { - "range": true } }, { - "description": "The number of results to return per page (default=1000, maximum=50000, minimum=1).", + "description": "The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted 'yyyy-mm-dd'.", "in": "query", - "name": "limit", + "name": "effective_date", "schema": { - "default": 1000, - "maximum": 50000, - "minimum": 1, - "type": "integer" + "type": "string" } }, { - "description": "Range by window_start.", + "description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.", "in": "query", - "name": "window_start.gte", + "name": "effective_date.gt", "schema": { "type": "string" } }, { - "description": "Range by window_start.", + "description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", "in": "query", - "name": "window_start.gt", + "name": "effective_date.gte", "schema": { "type": "string" } }, { - "description": "Range by window_start.", + "description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'.", "in": "query", - "name": "window_start.lte", + "name": "effective_date.lt", "schema": { "type": "string" } }, { - "description": "Range by window_start.", + "description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", "in": "query", - "name": "window_start.lt", + "name": "effective_date.lte", "schema": { "type": "string" } }, { - "description": "Sort results by field and direction using dotted notation (e.g., 'ticker.asc', 'name.desc').", + "description": "ETF Global's proprietary Red Diamond overall risk assessment score for the ETF. Value must be a floating point number.", "in": "query", - "name": "sort", + "name": "risk_total_score", "schema": { - "default": "window_start.desc", - "enum": [ - "window_start.asc", - "window_start.desc" - ], - "example": "window_start.desc", - "type": "string" + "format": "double", + "type": "number" } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "example": { - "request_id": "b452e45b7eaad14151c3e1ce5129b558", - "results": [ - { - "close": 2874.2, - "dollar_volume": 380560636.01, - "high": 2877.1, - "low": 2837.4, - "open": 2849.8, - "session_end_date": "2025-02-04", - "settlement_price": 2875.8, - "ticker": "GCJ5", - "transactions": 74223, - "volume": 133072, - "window_start": 1738627200000000000 - }, - { - "close": 2884.8, - "dollar_volume": 448429944.1, - "high": 2906, - "low": 2870.1, - "open": 2873.7, - "session_end_date": "2025-02-05", - "settlement_price": 2893, - "ticker": "GCJ5", - "transactions": 83673, - "volume": 155170, - "window_start": 1738713600000000000 - } - ], - "status": "OK" - }, - "schema": { - "properties": { - "next_url": { - "description": "If present, the URL to the next page of results.", - "type": "string" - }, - "results": { - "items": { - "properties": { - "close": { - "description": "The last price within the timeframe.", - "format": "double", - "type": "number" - }, - "dollar_volume": { - "description": "The total dollar volume of the transactions that occurred within the timeframe.", - "format": "double", - "type": "number" - }, - "high": { - "description": "The highest price within the timeframe.", - "format": "double", - "type": "number" - }, - "low": { - "description": "The lowest price within the timeframe.", - "format": "double", - "type": "number" - }, - "open": { - "description": "The opening price within the timeframe.", - "format": "double", - "type": "number" - }, - "session_end_date": { - "description": "Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format.", - "type": "string" - }, - "settlement_price": { - "description": "The price the contract would have cost to settle for this session.", - "format": "double", - "type": "number" - }, - "ticker": { - "description": "The ticker for the contract.", - "type": "string" - }, - "transaction_count": { - "description": "The number of transactions that occurred within the timeframe.", - "format": "int64", - "type": "integer" - }, - "volume": { - "description": "The number of contracts that traded within the timeframe.", - "format": "int64", - "type": "integer" - }, - "window_start": { - "description": "The timestamp of the beginning of the candlestick’s aggregation window.", - "format": "int64", - "type": "integer", - "x-polygon-go-type": { - "name": "INanoseconds", - "path": "github.com/polygon-io/ptime" - } - } - }, - "type": "object" - }, - "type": "array" - }, - "status": { - "description": "The status of the response.", - "type": "string" - } - }, - "type": "object" - } - } - }, - "description": "A list of aggregates." - } - }, - "summary": "Aggregates", - "tags": [ - "default" - ], - "x-polygon-entitlement-data-type": { - "description": "Aggregate data", - "name": "aggregates" - }, - "x-polygon-entitlement-market-type": { - "description": "Futures data", - "name": "futures" - } - } - }, - "/futures/vX/contracts": { - "get": { - "description": "The Contracts endpoint returns a list of futures contracts. This endpoint can be used to query for contracts based on a variety of parameters, including the contract's ticker, product code, first trade date, last trade date, and whether or not the contract was active on a given date.", - "operationId": "GetFuturesContracts", - "parameters": [ + }, { - "description": "A unique identifier for the Product a Contract belongs to. Note that multiple contracts can belong to the same product.", + "description": "Filter greater than the value. Value must be a floating point number.", "in": "query", - "name": "product_code", + "name": "risk_total_score.gt", "schema": { - "type": "string" + "format": "double", + "type": "number" } }, { - "description": "The first day that a contract was tradeable. A date with the format YYYY-MM-DD.", + "description": "Filter greater than or equal to the value. Value must be a floating point number.", "in": "query", - "name": "first_trade_date", + "name": "risk_total_score.gte", "schema": { - "format": "date", - "type": "string" + "format": "double", + "type": "number" } }, { - "description": "The last day that the contract was tradeable. A date with the format YYYY-MM-DD.", + "description": "Filter less than the value. Value must be a floating point number.", "in": "query", - "name": "last_trade_date", + "name": "risk_total_score.lt", "schema": { - "format": "date", - "type": "string" + "format": "double", + "type": "number" } }, { - "description": "Specify the point-in-time for which you want to retrieve information. Note that the contract data returned for a given date is the state of that contract as of that day. A date in the format YYYY-MM-DD (default=today).", + "description": "Filter less than or equal to the value. Value must be a floating point number.", "in": "query", - "name": "as_of", + "name": "risk_total_score.lte", "schema": { - "format": "date", - "type": "string" + "format": "double", + "type": "number" } }, { - "description": "Filter for contracts based on whether or not they were tradeable at the given point in time. For example, if the date queried is greater-than or equal-to a contract's 'first_trade_date' and less-than-or-equal-to its 'last_trade_date', then the contract was active. If the date queried is greater-than-or-equal-to the contract's 'last_trade_date' or less-than-or-equal-to its 'first_trade_date', then the contract was inactive.", + "description": "ETF Global's proprietary Green Diamond score measuring the potential reward and return prospects of the ETF. Value must be a floating point number.", "in": "query", - "name": "active", + "name": "reward_score", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "reward_score.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "reward_score.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "reward_score.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "reward_score.lte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "ETF Global's comprehensive quantitative analysis score combining all quantitative factors. Value must be a floating point number.", + "in": "query", + "name": "quant_total_score", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "quant_total_score.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "quant_total_score.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "quant_total_score.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "quant_total_score.lte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Letter grade summarizing the ETF's overall quantitative assessment, where A = 71-100, B = 56-70, etc.", + "in": "query", + "name": "quant_grade", "schema": { - "default": "all", - "enum": [ - "all", - "true", - "false" - ], "type": "string" } }, { - "description": "The type of contract, one of \"all\", \"single\", or \"combo\" (default=all).", + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", "in": "query", - "name": "type", + "name": "quant_grade.any_of", "schema": { - "default": "all", - "enum": [ - "all", - "single", - "combo" - ], "type": "string" } }, { - "description": "The number of results to return per page (default=100, max=1000, min=1).", + "description": "Filter greater than the value.", + "in": "query", + "name": "quant_grade.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "quant_grade.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "quant_grade.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "quant_grade.lte", + "schema": { + "type": "string" + } + }, + { + "description": "Combined technical analysis score aggregating short, intermediate, and long-term technical factors. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_technical", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_technical.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_technical.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_technical.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_technical.lte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Overall market sentiment score combining put/call ratios, short interest, and implied volatility. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_sentiment", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_sentiment.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_sentiment.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_sentiment.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_sentiment.lte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Behavioral analysis score measuring investor psychology and market behavior patterns. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_behavioral", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_behavioral.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_behavioral.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_behavioral.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_behavioral.lte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Overall fundamental analysis score combining P/E, P/CF, P/B, and dividend yield metrics. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_fundamental", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_fundamental.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_fundamental.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_fundamental.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_fundamental.lte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Overall global theme score combining sector and country analysis for macro investment views. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_global", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_global.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_global.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_global.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_global.lte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Overall quality assessment score combining liquidity, diversification, and issuing firm factors. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_quality", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_quality.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_quality.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_quality.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "quant_composite_quality.lte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'.", "in": "query", "name": "limit", "schema": { "default": 100, - "maximum": 1000, + "maximum": 5001, "minimum": 1, "type": "integer" } }, { - "description": "Sort results by field and direction using dotted notation (e.g., 'ticker.asc', 'name.desc').", + "description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'composite_ticker' if not specified. The sort order defaults to 'asc' if not specified.", "in": "query", "name": "sort", "schema": { - "default": "product_code.asc", - "enum": [ - "product_code.asc", - "product_code.desc", - "first_trade_date.asc", - "first_trade_date.desc", - "last_trade_date.asc", - "last_trade_date.desc" - ], - "example": "product_code.asc", + "default": "composite_ticker.asc", "type": "string" } } @@ -9812,41 +9980,44 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/futures/vX/contracts?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", - "request_id": "000a000a0a0a000a0a0aa00a0a0000a0", + "count": 1, + "request_id": 1, "results": [ { - "active": true, - "as_of": "2025-02-26", - "days_to_maturity": 138, - "first_trade_date": "2025-01-15", - "last_trade_date": "2025-07-14", - "max_order_quantity": 1999, - "min_order_quantity": 1, - "name": "00CN5 Future", - "product_code": "00C", - "settlement_date": "2025-07-14", - "settlement_tick_size": 0.0025, - "spread_tick_size": 0.0025, - "ticker": "00CN5", - "trade_tick_size": 0.0025, - "trading_venue": "XCBT", - "type": "single" - }, - { - "active": false, - "as_of": "2025-02-26", - "days_to_maturity": -12, - "first_trade_date": "2024-09-16", - "last_trade_date": "2025-02-14", - "max_order_quantity": 1999, - "min_order_quantity": 1, - "name": "00CG5 Future", - "product_code": "00C", - "settlement_date": "2025-02-14", - "ticker": "00CG5XXX", - "trading_venue": "XCBT", - "type": "single" + "composite_ticker": "SPY", + "effective_date": "2025-09-19", + "processed_date": "2025-09-19", + "quant_composite_behavioral": 67.1535, + "quant_composite_fundamental": 1.2, + "quant_composite_global": 52.9, + "quant_composite_quality": 75.9, + "quant_composite_sentiment": 54.6, + "quant_composite_technical": 79.7, + "quant_fundamental_div": 4.7, + "quant_fundamental_pb": 0, + "quant_fundamental_pcf": 0, + "quant_fundamental_pe": 0, + "quant_global_country": 85.4, + "quant_global_sector": 20.4, + "quant_grade": "D", + "quant_quality_diversification": 29.3, + "quant_quality_firm": 98.3, + "quant_quality_liquidity": 100, + "quant_sentiment_iv": 23, + "quant_sentiment_pc": 88.9, + "quant_sentiment_si": 51.6, + "quant_technical_it": 79, + "quant_technical_lt": 78.7, + "quant_technical_st": 83.1, + "quant_total_score": 40.2, + "reward_score": 3.12, + "risk_country": 1.46, + "risk_deviation": 7.68, + "risk_efficiency": 1.85, + "risk_liquidity": 2.5, + "risk_structure": 2.37, + "risk_total_score": 9.22, + "risk_volatility": 4.66 } ], "status": "OK" @@ -9854,667 +10025,666 @@ "schema": { "properties": { "next_url": { - "description": "If present, this value can be used to fetch the next page of data.", + "description": "If present, this value can be used to fetch the next page.", "type": "string" }, "request_id": { - "description": "A unique identifier for this request.", + "description": "A request id assigned by the server.", "type": "string" }, "results": { + "description": "The results for this request.", "items": { "properties": { - "active": { - "description": "Whether or not this contract was tradeable at the given point-in-time specified in the 'as_of' attribute (a contract was active if the given day was after the 'first_trade_date' and before the 'last_trade_date').", - "type": "boolean" - }, - "as_of": { - "description": "The point-in-time date for the given contract - e.g. if 'as_of' is set to 2021-04-25, then the data retrieved describes the contract(s) as of 2021-04-25.", - "format": "date", + "composite_ticker": { + "description": "The stock ticker symbol used to identify this ETF product on exchanges.", "type": "string" }, - "days_to_maturity": { - "description": "The number of days until this contract matures (since the point-in-time date). Note that the absence of this field means there are 0 days until maturity.", - "type": "integer" - }, - "first_trade_date": { - "description": "The date on which this contract first became tradeable.", + "effective_date": { + "description": "The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date.", "format": "date", "type": "string" }, - "last_trade_date": { - "description": "The date on which this contract last became tradeable.", + "processed_date": { + "description": "The date showing when ETF Global received and processed the data.", "format": "date", "type": "string" }, - "maturity": { - "description": "This field provides the calendar month reflected in the instrument symbol. For futures spreads and options spreads, this field contains the first leg's calendar month reflected in the instrument symbol. For daily products, this tag contains the full calendar date (YYYYMMDD) as reflected in the instrument symbol.", - "type": "string" + "quant_composite_behavioral": { + "description": "Behavioral analysis score measuring investor psychology and market behavior patterns.", + "format": "double", + "type": "number" }, - "max_order_quantity": { - "description": "The maximum order quantity for this contract.", - "type": "integer" + "quant_composite_fundamental": { + "description": "Overall fundamental analysis score combining P/E, P/CF, P/B, and dividend yield metrics.", + "format": "double", + "type": "number" }, - "min_order_quantity": { - "description": "The minimum order quantity for this contract.", - "type": "integer" + "quant_composite_global": { + "description": "Overall global theme score combining sector and country analysis for macro investment views.", + "format": "double", + "type": "number" }, - "name": { - "description": "The name of the contract.", - "type": "string" + "quant_composite_quality": { + "description": "Overall quality assessment score combining liquidity, diversification, and issuing firm factors.", + "format": "double", + "type": "number" }, - "product_code": { - "description": "The unique identifier for the product to which this contract belongs.", - "type": "string" + "quant_composite_sentiment": { + "description": "Overall market sentiment score combining put/call ratios, short interest, and implied volatility.", + "format": "double", + "type": "number" }, - "settlement_date": { - "description": "The final settlement date for the contract.", - "format": "date", - "type": "string" + "quant_composite_technical": { + "description": "Combined technical analysis score aggregating short, intermediate, and long-term technical factors.", + "format": "double", + "type": "number" }, - "settlement_tick_size": { - "description": "The settlement tick size for this contract.", + "quant_fundamental_div": { + "description": "Fundamental analysis score based on dividend yields of the ETF's underlying securities.", + "format": "double", "type": "number" }, - "spread_tick_size": { - "description": "The spread tick size for this contract.", + "quant_fundamental_pb": { + "description": "Fundamental analysis score based on price-to-book value ratios of the ETF's holdings.", + "format": "double", "type": "number" }, - "ticker": { - "description": "The unique identifier for the contract, typically consisting of the product code and expiration date.", - "type": "string" + "quant_fundamental_pcf": { + "description": "Fundamental analysis score based on price-to-cash-flow ratios of the ETF's underlying assets.", + "format": "double", + "type": "number" }, - "trade_tick_size": { - "description": "The tick size for this contract.", + "quant_fundamental_pe": { + "description": "Fundamental analysis score based on price-to-earnings ratios of the ETF's underlying holdings.", + "format": "double", "type": "number" }, - "trading_venue": { - "description": "The trading venue (MIC) for the exchange on which this contract trades.", - "type": "string" + "quant_global_country": { + "description": "Quantitative score analyzing global country themes and country-specific market factors.", + "format": "double", + "type": "number" }, - "type": { - "description": "The type of contract, one of \"single\" or \"combo\".", + "quant_global_sector": { + "description": "Quantitative score analyzing global sector themes and sector-specific performance factors.", + "format": "double", + "type": "number" + }, + "quant_grade": { + "description": "Letter grade summarizing the ETF's overall quantitative assessment, where A = 71-100, B = 56-70, etc.", "type": "string" - } - }, - "required": [ - "ticker", - "product_code", - "date", - "trading_venue", - "type" - ], - "type": "object", - "x-polygon-go-type": { - "name": "Contract" - } - }, - "type": "array" - }, - "status": { - "description": "The status of this request's response.", - "example": "OK", - "type": "string" - } - }, - "type": "object" - } - } - }, - "description": "A list of contracts which satify all query parameters." - } - }, - "summary": "Contracts", - "tags": [ - "default" - ], - "x-polygon-entitlement-data-type": { - "description": "Reference data", - "name": "reference" - } - } - }, - "/futures/vX/contracts/{ticker}": { - "get": { - "description": "The Contract Details endpoint returns the details for a single contract at a specific point in time.", - "operationId": "GetFuturesContractDetails", - "parameters": [ - { - "description": "The ticker symbol of the contract to retrieve.", - "example": "ESU0", - "in": "path", - "name": "ticker", - "required": true, - "schema": { - "type": "string" - } + }, + "quant_quality_diversification": { + "description": "Quality assessment score evaluating the diversification benefits and risk distribution of the ETF.", + "format": "double", + "type": "number" + }, + "quant_quality_firm": { + "description": "Quality assessment score evaluating the reputation and capabilities of the ETF's issuing firm.", + "format": "double", + "type": "number" + }, + "quant_quality_liquidity": { + "description": "Quality assessment score measuring the liquidity characteristics and trading ease of the ETF.", + "format": "double", + "type": "number" + }, + "quant_sentiment_iv": { + "description": "Market sentiment score derived from implied volatility levels in options markets.", + "format": "double", + "type": "number" + }, + "quant_sentiment_pc": { + "description": "Market sentiment score derived from put/call option ratios and options activity.", + "format": "double", + "type": "number" + }, + "quant_sentiment_si": { + "description": "Market sentiment score based on short interest levels and short selling activity.", + "format": "double", + "type": "number" + }, + "quant_technical_it": { + "description": "Intermediate-term technical analysis score evaluating medium-term price trends.", + "format": "double", + "type": "number" + }, + "quant_technical_lt": { + "description": "Long-term technical analysis score assessing extended price trend patterns.", + "format": "double", + "type": "number" + }, + "quant_technical_st": { + "description": "Short-term technical analysis score based on recent price movements and trading patterns.", + "format": "double", + "type": "number" + }, + "quant_total_score": { + "description": "ETF Global's comprehensive quantitative analysis score combining all quantitative factors.", + "format": "double", + "type": "number" + }, + "reward_score": { + "description": "ETF Global's proprietary Green Diamond score measuring the potential reward and return prospects of the ETF.", + "format": "double", + "type": "number" + }, + "risk_country": { + "description": "A component score assessing country-specific risks based on the ETF's geographic exposure.", + "format": "double", + "type": "number" + }, + "risk_deviation": { + "description": "A component score measuring how much the ETF deviates from expected performance.", + "format": "double", + "type": "number" + }, + "risk_efficiency": { + "description": "A component score assessing the operational efficiency and cost-effectiveness of the ETF.", + "format": "double", + "type": "number" + }, + "risk_liquidity": { + "description": "A component score measuring the liquidity risk and ease of trading the ETF.", + "format": "double", + "type": "number" + }, + "risk_structure": { + "description": "A component score evaluating risks related to the ETF's structural design and mechanics.", + "format": "double", + "type": "number" + }, + "risk_total_score": { + "description": "ETF Global's proprietary Red Diamond overall risk assessment score for the ETF.", + "format": "double", + "type": "number" + }, + "risk_volatility": { + "description": "A component score measuring the volatility risk of the ETF's price movements.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "type": "array" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "OK" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "results" + ], + "type": "object" + } + } + }, + "description": "A list of results." }, - { - "description": "The point-in-time of the data to be retrieved. Note that the contract data returned for a given date represents the state of that contract on that day. A date in the format YYYY-MM-DD (default=today).", - "in": "query", - "name": "as_of", - "schema": { - "format": "date", - "type": "string" - } - } - ], - "responses": { - "200": { + "400": { "content": { "application/json": { - "example": { - "request_id": "000a000a0a0a000a0a0aa00a0a0000a0", - "results": { - "active": true, - "as_of": "2025-07-07", - "days_to_maturity": 1901, - "first_trade_date": "2025-06-20", - "last_trade_date": "2030-09-20", - "max_order_quantity": 3000, - "min_order_quantity": 1, - "name": "ESU0 Future", - "product_code": "ES", - "settlement_tick_size": 0.25, - "spread_tick_size": 0.01, - "ticker": "ESU0", - "trade_tick_size": 0.25, - "trading_venue": "XCME", - "type": "single" - }, - "status": "OK" - }, "schema": { "properties": { - "request_id": { - "description": "A unique identifier for this request.", + "error": { + "description": "A message describing the source of the error.", "type": "string" }, - "results": { - "properties": { - "active": { - "description": "Whether or not this contract was tradeable at the given point-in-time specified in the 'as_of' attribute (a contract was active if the given day was after the 'first_trade_date' and before the 'last_trade_date').", - "type": "boolean" - }, - "as_of": { - "description": "The point-in-time date for the given contract - e.g. if 'as_of' is set to 2021-04-25, then the data retrieved describes the contract(s) as of 2021-04-25.", - "format": "date", - "type": "string" - }, - "days_to_maturity": { - "description": "The number of days until this contract matures (since the point-in-time date). Note that the absence of this field means there are 0 days until maturity.", - "type": "integer" - }, - "first_trade_date": { - "description": "The date on which this contract first became tradeable.", - "format": "date", - "type": "string" - }, - "last_trade_date": { - "description": "The date on which this contract last became tradeable.", - "format": "date", - "type": "string" - }, - "maturity": { - "description": "This field provides the calendar month reflected in the instrument symbol. For futures spreads and options spreads, this field contains the first leg's calendar month reflected in the instrument symbol. For daily products, this tag contains the full calendar date (YYYYMMDD) as reflected in the instrument symbol.", - "type": "string" - }, - "max_order_quantity": { - "description": "The maximum order quantity for this contract.", - "type": "integer" - }, - "min_order_quantity": { - "description": "The minimum order quantity for this contract.", - "type": "integer" - }, - "name": { - "description": "The name of the contract.", - "type": "string" - }, - "product_code": { - "description": "The unique identifier for the product to which this contract belongs.", - "type": "string" - }, - "settlement_date": { - "description": "The final settlement date for the contract.", - "format": "date", - "type": "string" - }, - "settlement_tick_size": { - "description": "The settlement tick size for this contract.", - "type": "number" - }, - "spread_tick_size": { - "description": "The spread tick size for this contract.", - "type": "number" - }, - "ticker": { - "description": "The unique identifier for the contract, typically consisting of the product code and expiration date.", - "type": "string" - }, - "trade_tick_size": { - "description": "The tick size for this contract.", - "type": "number" - }, - "trading_venue": { - "description": "The trading venue (MIC) for the exchange on which this contract trades.", - "type": "string" - }, - "type": { - "description": "The type of contract, one of \"single\" or \"combo\".", - "type": "string" - } - }, - "required": [ - "ticker", - "product_code", - "date", - "trading_venue", - "type" - ], - "type": "object", - "x-polygon-go-type": { - "name": "Contract" - } + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" }, "status": { "description": "The status of this request's response.", + "enum": [ + "ERROR" + ], "type": "string" } }, + "required": [ + "status", + "request_id", + "error" + ], "type": "object" } } }, - "description": "A single contract as it was at the given point-in-time." + "description": "An error message." } }, - "summary": "Contract Details", "tags": [ "default" - ], - "x-polygon-entitlement-data-type": { - "description": "Reference data", - "name": "reference" - } + ] } }, - "/futures/vX/market-status": { + "/etf-global/v1/constituents": { "get": { - "description": "The market status endpoint returns the current status of the futures market for the given product code(s).", - "operationId": "GetFuturesMarketStatuses", + "description": "ETF Global constituents data containing detailed information about the securities held within ETFs, including weights, market values, and security identifiers.", + "operationId": "get_etf-global_v1_constituents", "parameters": [ { - "description": "The product code(s) to return market statuses for.\n\nMultiple product codes can be specified by separating them with a comma. Currently, the limit is 250 product codes.", + "description": "The stock ticker symbol of the ETF that holds these constituent securities.", "in": "query", - "name": "product_code.any_of", + "name": "composite_ticker", "schema": { - "example": "ES,CL", "type": "string" } }, { - "description": "The product code to return market statuses for.", + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", "in": "query", - "name": "product_code", + "name": "composite_ticker.any_of", "schema": { - "example": "ES", "type": "string" } }, { - "description": "The number of results to return per page (default=100, max=1000, min=1).", + "description": "Filter greater than the value.", "in": "query", - "name": "limit", + "name": "composite_ticker.gt", "schema": { - "default": 100, - "maximum": 1000, - "minimum": 1, - "type": "integer" + "type": "string" } }, { - "description": "Sort results by field and direction using dotted notation (e.g., 'ticker.asc', 'name.desc').", + "description": "Filter greater than or equal to the value.", "in": "query", - "name": "sort", + "name": "composite_ticker.gte", "schema": { - "default": "product_code.asc", - "enum": [ - "product_code.asc", - "product_code.desc" - ], - "example": "product_code.asc", "type": "string" } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "next_url": { - "description": "If present, this value can be used to fetch the next page of data.", - "example": "https://api.polygon.io/futures/vX/products?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", - "type": "string" - }, - "request_id": { - "description": "A unique identifier for this request.", - "example": "ac0a1b0b-0b0b-4b0b-8b0b-0b0b0b0b0b0b", - "type": "string" - }, - "results": { - "items": { - "properties": { - "market_status": { - "description": "The current status of the market.", - "enum": [ - "pre_open", - "open", - "close", - "pause", - "post_close_pre_open" - ], - "example": "open", - "type": "string" - }, - "product_code": { - "description": "The product code for the product.", - "example": "ES", - "type": "string" - }, - "trading_venue": { - "description": "The trading venue (MIC) for the exchange on which the corresponding product trades.", - "example": "XNYM", - "type": "string" - } - }, - "required": [ - "market_status", - "product_code" - ], - "type": "object", - "x-polygon-go-type": { - "name": "MarketStatusesResult" - } - }, - "type": "array" - }, - "status": { - "description": "The status of this request's response.", - "example": "OK", - "type": "string" - }, - "timestamp": { - "description": "An RFC3339 timestamp representing the moment at which the market statuses were evaluated.", - "example": "2025-02-27T13:26:35.905149Z", - "format": "date-time", - "type": "string" - } - }, - "type": "object" - } - } - }, - "description": "A list of statuses for each product and market identifier code." - } - }, - "summary": "Market Status", - "tags": [ - "default" - ], - "x-polygon-entitlement-data-type": { - "description": "Reference data", - "name": "reference" - } - } - }, - "/futures/vX/products": { - "get": { - "description": "The Products endpoint returns a list of futures products. This endpoint can be used to query for products based on a variety of parameters, including by the product's name, exchange, sector, sub-sector, asset class, asset sub-class, and type.", - "operationId": "GetFuturesProducts", - "parameters": [ + }, { - "description": "Search for products by Product Name. This parameter supports an exact match, while a name-contains search can be performed using the `name.search` parameter. Note that the search is case-sensitive.", + "description": "Filter less than the value.", "in": "query", - "name": "name", + "name": "composite_ticker.lt", "schema": { "type": "string" - }, - "x-polygon-filter-field": { - "search": true } }, { - "description": "A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about products for the specified day (default=today).", + "description": "Filter less than or equal to the value.", "in": "query", - "name": "as_of", + "name": "composite_ticker.lte", "schema": { - "format": "date", "type": "string" } }, { - "description": "The trading venue (MIC) for the exchange on which the products trades.", + "description": "The stock ticker symbol of the individual security held within the ETF.", "in": "query", - "name": "trading_venue", + "name": "constituent_ticker", "schema": { "type": "string" } }, { - "description": "The sector to which the products belong.", + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", "in": "query", - "name": "sector", + "name": "constituent_ticker.any_of", "schema": { - "enum": [ - "asia", - "base", - "biofuels", - "coal", - "cross_rates", - "crude_oil", - "custom_index", - "dairy", - "dj_ubs_ci", - "electricity", - "emissions", - "europe", - "fertilizer", - "forestry", - "grains_and_oilseeds", - "intl_index", - "liq_nat_gas_lng", - "livestock", - "long_term_gov", - "long_term_non_gov", - "majors", - "minors", - "nat_gas", - "nat_gas_liq_petro", - "precious", - "refined_products", - "s_and_p_gsci", - "sel_sector_index", - "short_term_gov", - "short_term_non_gov", - "softs", - "us", - "us_index", - "wet_bulk" - ], "type": "string" } }, { - "description": "The sub-sector to which the products belong.", + "description": "Filter greater than the value.", "in": "query", - "name": "sub_sector", + "name": "constituent_ticker.gt", "schema": { - "enum": [ - "asian", - "canadian", - "cat", - "cooling_degree_days", - "ercot", - "european", - "gulf", - "heating_degree_days", - "iso_ne", - "large_cap_index", - "mid_cap_index", - "miso", - "north_american", - "nyiso", - "pjm", - "small_cap_index", - "west", - "western_power" - ], "type": "string" } }, { - "description": "The asset class to which the products belong.", + "description": "Filter greater than or equal to the value.", "in": "query", - "name": "asset_class", + "name": "constituent_ticker.gte", "schema": { - "enum": [ - "alt_investment", - "commodity", - "financials" - ], "type": "string" } }, { - "description": "The asset sub-class to which the products belong.", + "description": "Filter less than the value.", "in": "query", - "name": "asset_sub_class", + "name": "constituent_ticker.lt", "schema": { - "enum": [ - "agricultural", - "commodity_index", - "energy", - "equity", - "foreign_exchange", - "freight", - "housing", - "interest_rate", - "metals", - "weather" - ], "type": "string" } }, { - "description": "The type of products to return. One of \"all\", \"single\", or \"combo\" (default=all).", + "description": "Filter less than or equal to the value.", "in": "query", - "name": "type", + "name": "constituent_ticker.lte", "schema": { - "default": "all", - "enum": [ - "all", - "single", - "combo" - ], "type": "string" } }, { - "description": "The number of results to return per page (default=100, maximum=1000, minimum=1).", + "description": "The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted 'yyyy-mm-dd'.", "in": "query", - "name": "limit", + "name": "effective_date", "schema": { - "default": 100, - "maximum": 1000, - "minimum": 1, - "type": "integer" + "type": "string" } }, { - "description": "Search by name.", + "description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.", "in": "query", - "name": "name.search", + "name": "effective_date.gt", "schema": { "type": "string" } }, { - "description": "Sort results by field and direction using dotted notation (e.g., 'ticker.asc', 'name.desc').", + "description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", "in": "query", - "name": "sort", + "name": "effective_date.gte", "schema": { - "default": "name.asc", - "enum": [ - "name.asc", - "name.desc", - "trading_venue.asc", - "trading_venue.desc", - "sector.asc", - "sector.desc", - "sub_sector.asc", - "sub_sector.desc", - "asset_class.asc", - "asset_class.desc", - "asset_sub_class.asc", - "asset_sub_class.desc", - "type.asc", - "type.desc" - ], - "example": "name.asc", "type": "string" } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "example": { - "next_url": "https://api.polygon.io/futures/vX/products?cursor=YXA9MTAwJmFzPSZhc19vZj0yMDI1LTA3LTA3JmxpbWl0PTEwMCZzb3J0PW5hbWUuYXNj", - "request_id": "000a000a0a0a000a0a0aa00a0a0000a0", - "results": [ - { - "asset_class": "commodity", - "asset_sub_class": "energy", - "clearing_channel": "exchange_only", - "date": "2025-07-07", - "last_updated": "2025-02-22", - "name": "1% Fuel Oil Barges FOB Rdam (Platts) vs. 1% Fuel Oil Cargoes FOB NWE (Platts) BALMO Futures", - "price_quotation": "U.S. dollars and cents per metric ton", - "product_code": "EBE", - "sector": "refined_products", - "settlement_currency_code": "USD", - "settlement_method": "financially_settled", - "settlement_type": "cash", - "sub_sector": "european", - "trade_currency_code": "USD", - "trading_venue": "XNYM", - "type": "single", - "unit_of_measure": "MTONS", - "unit_of_measure_quantity": 1000 - }, + }, + { + "description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "effective_date.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "effective_date.lte", + "schema": { + "type": "string" + } + }, + { + "description": "The date showing when ETF Global received and processed the data. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "processed_date", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "processed_date.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "processed_date.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "processed_date.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "processed_date.lte", + "schema": { + "type": "string" + } + }, + { + "description": "A unique identifier code for the constituent security in US markets.", + "in": "query", + "name": "us_code", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "us_code.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "us_code.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "us_code.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "us_code.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "us_code.lte", + "schema": { + "type": "string" + } + }, + { + "description": "The International Securities Identification Number, a global standard for identifying securities.", + "in": "query", + "name": "isin", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "isin.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "isin.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "isin.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "isin.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "isin.lte", + "schema": { + "type": "string" + } + }, + { + "description": "The Financial Instrument Global Identifier, an open standard for uniquely identifying financial instruments.", + "in": "query", + "name": "figi", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "figi.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "figi.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "figi.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "figi.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "figi.lte", + "schema": { + "type": "string" + } + }, + { + "description": "The Stock Exchange Daily Official List code, primarily used for securities trading in the UK.", + "in": "query", + "name": "sedol", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "sedol.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "sedol.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "sedol.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "sedol.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "sedol.lte", + "schema": { + "type": "string" + } + }, + { + "description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'.", + "in": "query", + "name": "limit", + "schema": { + "default": 100, + "maximum": 5001, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'composite_ticker' if not specified. The sort order defaults to 'asc' if not specified.", + "in": "query", + "name": "sort", + "schema": { + "default": "composite_ticker.asc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "count": 1, + "request_id": 1, + "results": [ { - "asset_class": "commodity", - "asset_sub_class": "energy", - "clearing_channel": "exchange_only", - "date": "2025-07-07", - "last_updated": "2025-06-25", - "name": "1% Fuel Oil Cargoes CIF MED (Platts) BALMO Futures", - "price_quotation": "U.S. dollars and cents per metric ton", - "product_code": "AOB", - "sector": "refined_products", - "settlement_currency_code": "USD", - "settlement_method": "financially_settled", - "settlement_type": "cash", - "sub_sector": "european", - "trade_currency_code": "USD", - "trading_venue": "XNYM", - "type": "single", - "unit_of_measure": "MTONS", - "unit_of_measure_quantity": 1000 + "asset_class": "Equity", + "composite_ticker": "SPY", + "constituent_name": "CAESARS ENTERTAINMENT INC COMMON STOCK", + "constituent_ticker": "CZR", + "country_of_exchange": "US", + "currency_traded": "USD", + "effective_date": "2025-09-18", + "figi": "BBG0074Q3NK6", + "isin": "US12769G1004", + "market_value": 63308625.6, + "processed_date": "2025-09-19", + "security_type": "Common Stock", + "sedol": "BMWWGB0", + "shares_held": 2398054, + "us_code": "12769G100", + "weight": 0.0000958005 } ], "status": "OK" @@ -10522,163 +10692,302 @@ "schema": { "properties": { "next_url": { - "description": "If present, this value can be used to fetch the next page of data.", + "description": "If present, this value can be used to fetch the next page.", "type": "string" }, "request_id": { - "description": "A unique identifier for this request.", + "description": "A request id assigned by the server.", "type": "string" }, "results": { + "description": "The results for this request.", "items": { "properties": { - "as_of": { - "description": "The point-in-time date for the given product - e.g. if 'as_of' is set to 2024-11-05, then these were the details for this product on that day.", - "format": "date", - "type": "string" - }, "asset_class": { - "description": "The asset class to which the product belongs.", + "description": "The broad category of asset type, such as Equity, Corporate Bond, Municipal Bond, etc.", "type": "string" }, - "asset_sub_class": { - "description": "The asset sub-class to which the product belongs.", + "composite_ticker": { + "description": "The stock ticker symbol of the ETF that holds these constituent securities.", "type": "string" }, - "clearing_channel": { - "description": "The clearing channel for this product. Indicates whether the product can be cleared only through exchanges or through both exchanges and over-the-counter.", - "enum": [ - "exchange_only", - "exchange_and_otc" - ], + "constituent_name": { + "description": "The full company or security name of the constituent holding.", "type": "string" }, - "last_updated": { - "description": "The date and time at which this product was last updated.", - "format": "date-time", + "constituent_ticker": { + "description": "The stock ticker symbol of the individual security held within the ETF.", "type": "string" }, - "name": { - "description": "The full name of the product.", + "country_of_exchange": { + "description": "The country where the exchange that lists this constituent security is located.", "type": "string" }, - "price_quotation": { - "description": "The quoted price for this product.", + "currency_traded": { + "description": "The local currency in which this constituent security is denominated and traded.", "type": "string" }, - "product_code": { - "description": "The unique identifier for the product.", + "effective_date": { + "description": "The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date.", + "format": "date", "type": "string" }, - "sector": { - "description": "The sector to which the product belongs.", + "exchange": { + "description": "The name of the stock exchange where this constituent security is primarily traded.", "type": "string" }, - "settlement_currency_code": { - "description": "The currency in which this product settles.", + "figi": { + "description": "The Financial Instrument Global Identifier, an open standard for uniquely identifying financial instruments.", "type": "string" }, - "settlement_method": { - "description": "The method of settlement for this product (Financially Settled or Deliverable).", + "isin": { + "description": "The International Securities Identification Number, a global standard for identifying securities.", "type": "string" }, - "settlement_type": { - "description": "The type of settlement for this product.", - "type": "string" + "market_value": { + "description": "The total market value of this constituent position held by the ETF.", + "format": "double", + "type": "number" }, - "sub_sector": { - "description": "The sub-sector to which the product belongs.", + "processed_date": { + "description": "The date showing when ETF Global received and processed the data.", + "format": "date", "type": "string" }, - "trade_currency_code": { - "description": "The currency in which this product trades.", + "security_type": { + "description": "The specific classification of security type using ETF Global's taxonomy, such as Common Equity, Domestic, Global, etc.", "type": "string" }, - "trading_venue": { - "description": "The trading venue (MIC) for the exchange on which this contract trades.", + "sedol": { + "description": "The Stock Exchange Daily Official List code, primarily used for securities trading in the UK.", "type": "string" }, - "type": { - "description": "The type of product, one of \"single\" or \"combo\".", - "type": "string" + "shares_held": { + "description": "The number of shares of this constituent security that the ETF currently owns.", + "format": "double", + "type": "number" }, - "unit_of_measure": { - "description": "The unit of measure for this product.", + "us_code": { + "description": "A unique identifier code for the constituent security in US markets.", "type": "string" }, - "unit_of_measure_quantity": { - "description": "The quantity of the unit of measure for this product.", + "weight": { + "description": "The percentage weight of this constituent security within the ETF's total portfolio.", + "format": "double", "type": "number" } }, - "required": [ - "product_code", - "date" - ], - "type": "object", - "x-polygon-go-type": { - "name": "Product" - } + "type": "object" }, "type": "array" }, "status": { "description": "The status of this request's response.", - "example": "OK", + "enum": [ + "OK" + ], "type": "string" } }, + "required": [ + "status", + "request_id", + "results" + ], "type": "object" } } }, - "description": "A list of products which match all of the query parameters." + "description": "A list of results." + }, + "400": { + "content": { + "application/json": { + "schema": { + "properties": { + "error": { + "description": "A message describing the source of the error.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "ERROR" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "error" + ], + "type": "object" + } + } + }, + "description": "An error message." } }, - "summary": "Products", "tags": [ "default" - ], - "x-polygon-entitlement-data-type": { - "description": "Reference data", - "name": "reference" - } + ] } }, - "/futures/vX/products/{product_code}": { + "/etf-global/v1/fund-flows": { "get": { - "description": "The Product Details endpoint returns the details for a single product as of a specific day.", - "operationId": "GetFuturesProductDetails", + "description": "ETF Global fund flow data containing information about ETF share movements, net asset values, and fund flow metrics.", + "operationId": "get_etf-global_v1_fund-flows", "parameters": [ { - "description": "The unique identifier for a product.", - "example": "ES", - "in": "path", - "name": "product_code", - "required": true, + "description": "The date showing when ETF Global received and processed the data. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "processed_date", "schema": { "type": "string" } }, { - "description": "The type of product to return. One of \"single\" or \"combo\" (default=single).", + "description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.", "in": "query", - "name": "type", + "name": "processed_date.gt", "schema": { - "default": "single", - "enum": [ - "single", - "combo" - ], "type": "string" } }, { - "description": "A date string in the format YYYY-MM-DD. Note that the data returned is the state of this product's data at that point-in-time.", + "description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", "in": "query", - "name": "as_of", + "name": "processed_date.gte", "schema": { - "format": "date", + "type": "string" + } + }, + { + "description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "processed_date.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "processed_date.lte", + "schema": { + "type": "string" + } + }, + { + "description": "The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "effective_date", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "effective_date.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "effective_date.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "effective_date.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "effective_date.lte", + "schema": { + "type": "string" + } + }, + { + "description": "The stock ticker symbol used to identify this ETF on exchanges.", + "in": "query", + "name": "composite_ticker", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "composite_ticker.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "composite_ticker.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "composite_ticker.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "composite_ticker.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "composite_ticker.lte", + "schema": { + "type": "string" + } + }, + { + "description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'.", + "in": "query", + "name": "limit", + "schema": { + "default": 100, + "maximum": 5001, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'composite_ticker' if not specified. The sort order defaults to 'asc' if not specified.", + "in": "query", + "name": "sort", + "schema": { + "default": "composite_ticker.asc", "type": "string" } } @@ -10688,232 +10997,291 @@ "content": { "application/json": { "example": { - "request_id": "000a000a0a0a000a0a0aa00a0a0000a0", - "results": { - "asset_class": "financials", - "asset_sub_class": "equity", - "clearing_channel": "exchange_only", - "date": "2025-07-07", - "last_updated": "2025-07-04", - "name": "E-mini S&P 500 Futures", - "price_quotation": "U.S. dollars and cents per index point", - "product_code": "ES", - "sector": "us_index", - "settlement_currency_code": "USD", - "settlement_method": "financially_settled", - "settlement_type": "cash", - "sub_sector": "small_cap_index", - "trade_currency_code": "USD", - "trading_venue": "XCME", - "type": "single", - "unit_of_measure": "IPNT", - "unit_of_measure_quantity": 50 - }, + "count": 1, + "request_id": 1, + "results": [ + { + "composite_ticker": "SPY", + "effective_date": "2025-01-29", + "fund_flow": -30235124.7, + "nav": 601.877341, + "processed_date": "2025-01-29", + "shares_outstanding": 1047232116 + }, + { + "composite_ticker": "SPY", + "effective_date": "2025-01-30", + "fund_flow": -2798729635.65, + "nav": 605.0574, + "processed_date": "2025-01-30", + "shares_outstanding": 1042582116 + }, + { + "composite_ticker": "SPY", + "effective_date": "2025-01-31", + "fund_flow": -3358068570, + "nav": 602.044248, + "processed_date": "2025-01-31", + "shares_outstanding": 1037032116 + } + ], "status": "OK" }, "schema": { "properties": { + "next_url": { + "description": "If present, this value can be used to fetch the next page.", + "type": "string" + }, "request_id": { - "description": "A unique identifier for this request.", + "description": "A request id assigned by the server.", "type": "string" }, "results": { - "properties": { - "as_of": { - "description": "The point-in-time date for the given product - e.g. if 'as_of' is set to 2024-11-05, then these were the details for this product on that day.", - "format": "date", - "type": "string" - }, - "asset_class": { - "description": "The asset class to which the product belongs.", - "type": "string" - }, - "asset_sub_class": { - "description": "The asset sub-class to which the product belongs.", - "type": "string" - }, - "clearing_channel": { - "description": "The clearing channel for this product. Indicates whether the product can be cleared only through exchanges or through both exchanges and over-the-counter.", - "enum": [ - "exchange_only", - "exchange_and_otc" - ], - "type": "string" - }, - "last_updated": { - "description": "The date and time at which this product was last updated.", - "format": "date-time", - "type": "string" - }, - "name": { - "description": "The full name of the product.", - "type": "string" - }, - "price_quotation": { - "description": "The quoted price for this product.", - "type": "string" - }, - "product_code": { - "description": "The unique identifier for the product.", - "type": "string" - }, - "sector": { - "description": "The sector to which the product belongs.", - "type": "string" - }, - "settlement_currency_code": { - "description": "The currency in which this product settles.", - "type": "string" - }, - "settlement_method": { - "description": "The method of settlement for this product (Financially Settled or Deliverable).", - "type": "string" - }, - "settlement_type": { - "description": "The type of settlement for this product.", - "type": "string" - }, - "sub_sector": { - "description": "The sub-sector to which the product belongs.", - "type": "string" - }, - "trade_currency_code": { - "description": "The currency in which this product trades.", - "type": "string" - }, - "trading_venue": { - "description": "The trading venue (MIC) for the exchange on which this contract trades.", - "type": "string" - }, - "type": { - "description": "The type of product, one of \"single\" or \"combo\".", - "type": "string" - }, - "unit_of_measure": { - "description": "The unit of measure for this product.", - "type": "string" + "description": "The results for this request.", + "items": { + "properties": { + "composite_ticker": { + "description": "The stock ticker symbol used to identify this ETF on exchanges.", + "type": "string" + }, + "effective_date": { + "description": "The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date.", + "format": "date", + "type": "string" + }, + "fund_flow": { + "description": "The net daily capital flow into or out of the ETF through the creation and redemption process, where positive values indicate inflows and negative values indicate outflows.", + "format": "double", + "type": "number" + }, + "nav": { + "description": "The net asset value per share, representing the per-share value of the ETF's underlying holdings.", + "format": "double", + "type": "number" + }, + "processed_date": { + "description": "The date showing when ETF Global received and processed the data.", + "format": "date", + "type": "string" + }, + "shares_outstanding": { + "description": "The total number of ETF shares currently issued and outstanding in the market.", + "format": "double", + "type": "number" + } }, - "unit_of_measure_quantity": { - "description": "The quantity of the unit of measure for this product.", - "type": "number" - } + "type": "object" }, - "required": [ - "product_code", - "date" + "type": "array" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "OK" ], - "type": "object", - "x-polygon-go-type": { - "name": "Product" - } + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "results" + ], + "type": "object" + } + } + }, + "description": "A list of results." + }, + "400": { + "content": { + "application/json": { + "schema": { + "properties": { + "error": { + "description": "A message describing the source of the error.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" }, "status": { "description": "The status of this request's response.", + "enum": [ + "ERROR" + ], "type": "string" } }, + "required": [ + "status", + "request_id", + "error" + ], "type": "object" } } }, - "description": "A single Product as it was at the given point-in-time." + "description": "An error message." } }, - "summary": "Product Details", "tags": [ "default" - ], - "x-polygon-entitlement-data-type": { - "description": "Reference data", - "name": "reference" - } + ] } }, - "/futures/vX/products/{product_code}/schedules": { + "/etf-global/v1/profiles": { "get": { - "description": "The Product-Specific Futures Schedules API provides detailed trading schedules for a specific futures product. This API allows you to query schedules for a single product across a range of dates. Users can access comprehensive information about trading sessions, including market events such as preopen, open, and closed, along with their precise timestamps.", - "operationId": "GetFuturesProductSchedules", + "description": "ETF Global industry profile data containing comprehensive ETF metadata including financial metrics, operational details, and exposure information.", + "operationId": "get_etf-global_v1_profiles", "parameters": [ { - "description": "The product code for the futures product.", - "example": "ES", - "in": "path", - "name": "product_code", - "required": true, + "description": "The date showing when ETF Global received and processed the data. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "processed_date", "schema": { "type": "string" } }, { - "description": "The date on which the schedule's trading day ended (sometimes referred to as trading date). Defaults to today. Formatted as `YYYY-MM-DD`. Note that although there is no time component the day is assumed to be that day in Central Time.", + "description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.", "in": "query", - "name": "session_end_date", + "name": "processed_date.gt", "schema": { - "format": "date", "type": "string" - }, - "x-polygon-filter-field": { - "range": true } }, { - "description": "The number of results to return per page (default=100, max=1000, min=1).", + "description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", "in": "query", - "name": "limit", + "name": "processed_date.gte", "schema": { - "default": 100, - "maximum": 1000, - "minimum": 1, - "type": "integer" + "type": "string" } }, { - "description": "Range by session_end_date.", + "description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'.", "in": "query", - "name": "session_end_date.gte", + "name": "processed_date.lt", "schema": { - "format": "date", "type": "string" } }, { - "description": "Range by session_end_date.", + "description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", "in": "query", - "name": "session_end_date.gt", + "name": "processed_date.lte", "schema": { - "format": "date", "type": "string" } }, { - "description": "Range by session_end_date.", + "description": "The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted 'yyyy-mm-dd'.", "in": "query", - "name": "session_end_date.lte", + "name": "effective_date", "schema": { - "format": "date", "type": "string" } }, { - "description": "Range by session_end_date.", + "description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.", "in": "query", - "name": "session_end_date.lt", + "name": "effective_date.gt", "schema": { - "format": "date", "type": "string" } }, { - "description": "Sort results by field and direction using dotted notation (e.g., 'ticker.asc', 'name.desc').", + "description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "effective_date.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "effective_date.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "effective_date.lte", + "schema": { + "type": "string" + } + }, + { + "description": "The stock ticker symbol used to identify this ETF product on exchanges.", + "in": "query", + "name": "composite_ticker", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "composite_ticker.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "composite_ticker.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "composite_ticker.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "composite_ticker.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "composite_ticker.lte", + "schema": { + "type": "string" + } + }, + { + "description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'.", + "in": "query", + "name": "limit", + "schema": { + "default": 100, + "maximum": 5001, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'composite_ticker' if not specified. The sort order defaults to 'asc' if not specified.", "in": "query", "name": "sort", "schema": { - "default": "session_end_date.desc", - "enum": [ - "session_end_date.asc", - "session_end_date.desc" - ], - "example": "session_end_date.desc", + "default": "composite_ticker.asc", "type": "string" } } @@ -10923,719 +11291,8895 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/futures/vX/products/ES/schedules?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", - "request_id": "000a000a0a0a000a0a0aa00a0a0000a0", + "count": 1, + "request_id": 1, "results": [ { - "example": "E-Mini S&P 500 Futures", - "product_code": "ES", - "product_name": "E-Mini S&P 500 Futures", - "schedule": [ - { - "event": "pre_open", - "timestamp": "2025-11-24T18:45:00:00-06:00" - }, - { - "event": "open", - "timestamp": "2025-11-24T19:00:00-06:00" - }, - { - "event": "close", - "timestamp": "2025-11-25T18:00:00-06:00" - } - ], - "session_end_date": "2025-11-24", - "trading_venue": "XNYM" - }, - { - "product_code": "ES", - "product_name": "E-Mini S&P 500 Futures", - "schedule": [ - { - "event": "pre_open", - "timestamp": "2025-11-24T18:45:00:00-06:00" - }, - { - "event": "open", - "timestamp": "2025-11-24T19:00:00-06:00" - }, - { - "event": "close", - "timestamp": "2025-11-25T18:00:00-06:00" - } - ], - "session_end_date": "2025-11-21", - "trading_venue": "XNYM" + "administrator": "State Street Bank and Trust Company", + "advisor": "SSgA Funds Management, Inc.", + "asset_class": "Equity", + "aum": 624531939442.66, + "avg_daily_trading_volume": 51287737.3, + "bid_ask_spread": 0.000042, + "call_volume": 4797339, + "category": "Size and Style", + "composite_ticker": "SPY", + "creation_fee": 3000, + "creation_unit_size": 50000, + "currency_exposure": { + "usd": 1.003 + }, + "custodian": "State Street Bank and Trust Company", + "description": "SPDR S&P 500 ETF Trust", + "development_class": "Developed Markets", + "discount_premium": 0.136123, + "distribution_frequency": "Q", + "distributor": "ALPS Distributors, Inc.", + "effective_date": "2025-01-02", + "fee_waivers": 0, + "fiscal_year_end": "31-Aug", + "focus": "Large Cap", + "geographic_exposure": { + "bm": 0.001, + "ch": 0.003, + "ie": 0.021, + "je": 0.001, + "lr": 0.001, + "nl": 0.001, + "pa": 0.001, + "us": 0.967 + }, + "inception_date": "1993-01-22", + "industry_exposure": { + "aerospace_and_defense": 0.011, + "air_freight_and_logistics": 0.004, + "airlines": 0.002, + "auto_components": 0, + "automobiles": 0.024, + "banks": 0.033, + "beverages": 0.011, + "biotechnology": 0.047, + "building_products": 0.002, + "capital_markets": 0.029, + "cash_or_derivatives": 0.003, + "chemicals": 0.007, + "commercial_services_and_supplies": 0.004, + "communications_equipment": 0.081, + "construction_and_engineering": 0.001, + "construction_materials": 0.001, + "consumer_products": 0.001, + "containers_and_packaging": 0.001, + "distributors": 0.001, + "diversified_consumer_services": 0.005, + "diversified_financial_services": 0.029, + "diversified_telecommunication_services": 0.009, + "electrical_equipment": 0.009, + "electronic_equipment_instruments_and_components": 0.001, + "entertainment": 0.008, + "equity_real_estate_investment": 0.001, + "food_products": 0.006, + "health_care_equipment_and_supplies": 0.031, + "health_care_providers_and_services": 0.018, + "health_care_technology": 0.003, + "hotels,_restaurants_and_leisure": 0.001, + "hotels_restaurants_and_leisure": 0.014, + "household_durables": 0.004, + "household_products": 0.011, + "industrial_conglomerates": 0.005, + "insurance": 0.035, + "it_services": 0.021, + "leisure_products": 0, + "machinery": 0.013, + "media": 0.077, + "metals_and_mining": 0.003, + "oil_gas_and_consumable_fuels": 0.031, + "real_estate_management_and_development": 0.018, + "renewable_energy": 0.001, + "road_and_rail": 0.003, + "semiconductors_and_semiconductor_equipment": 0.115, + "software": 0.101, + "specialty_retail": 0.082, + "technology_hardware_storage_and_peripherals": 0.001, + "textiles_apparel_and_luxury_goods": 0.003, + "tobacco": 0.006, + "trading_companies_and_distributors": 0.002, + "transportation_infrastructure": 0.006, + "utilities": 0.022 + }, + "industry_group_exposure": { + "automobiles_and_components": 0.024, + "banks": 0.033, + "capital_goods": 0.045, + "cash_or_derivatives": 0.003, + "commercial_and_professional_services": 0.005, + "consumer_durables_and_apparel": 0.007, + "consumer_services": 0.02, + "diversified_financials": 0.058, + "energy": 0.032, + "food_and_staples_retailing": 0.018, + "food_beverage_and_tobacco": 0.023, + "health_care_equipment_and_services": 0.046, + "household_and_personal_products": 0.011, + "insurance": 0.035, + "materials": 0.013, + "media_and_entertainment": 0.084, + "pharmaceuticals_biotechnology_and_life_sciences": 0.053, + "real_estate": 0.02, + "retailing": 0.065, + "semiconductors_and_semiconductor_equipment": 0.115, + "software_and_services": 0.12, + "technology_hardware_and_equipment": 0.084, + "telecommunication_services": 0.009, + "transportation": 0.002, + "transportation_and_logistics": 0.012, + "utilities": 0.022 + }, + "issuer": "SSgA", + "lead_market_maker": "None", + "leverage_style": "unleveraged", + "levered_amount": 0, + "listing_exchange": "NYSE Arca, Inc.", + "management_classification": "passive", + "management_fee": 0.0945, + "net_expenses": 0.0945, + "num_holdings": 504, + "options_available": 1, + "options_volume": 9346839, + "other_expenses": 0, + "primary_benchmark": "S&P 500 Index", + "processed_date": "2025-01-02", + "product_type": "etf", + "put_call_ratio": 0.948338, + "put_volume": 4549500, + "region": "North America", + "sector_exposure": { + "cash_or_derivatives": 0.003, + "communications": 0.094, + "consumer_discretionary": 0.113, + "consumer_staples": 0.054, + "energy": 0.032, + "financials": 0.131, + "health_care": 0.099, + "industrials": 0.068, + "materials": 0.013, + "real_estate": 0.02, + "technology": 0.321, + "utilities": 0.022 + }, + "short_interest": 106750000, + "subindustry_exposure": { + "advertising": 0.001, + "aerospace_and_defense": 0.011, + "agricultural_and_farm_machinery": 0.002, + "agricultural_products": 0.001, + "air_freight_and_logistics": 0.004, + "airlines": 0.002, + "alternative_carriers": 0.009, + "apparel_accessories_and_luxury": 0.003, + "apparel_retail": 0.005, + "application_software": 0.024, + "asset_management_and_custody_banks": 0.006, + "auto_parts_and_equipment": 0, + "automobile_manufacturers": 0.024, + "automotive_retail": 0.004, + "biotechnology": 0.047, + "brewers": 0, + "building_products": 0.002, + "cable_and_satellite": 0.004, + "cash_or_derivatives": 0.003, + "casinos_and_gaming": 0.001, + "commodity_chemicals": 0.001, + "communications_equipment": 0.081, + "construction_and_engineering": 0.001, + "construction_machinery_and_heavy_trucks": 0.006, + "construction_materials": 0.001, + "consumer_electronics": 0.001, + "consumer_finance": 0.029, + "data_processing_and_outsourced_services": 0.006, + "distillers_and_vintners": 0.001, + "distributors": 0, + "diversified_banks": 0.033, + "diversified_chemicals": 0.002, + "diversified_metals_and_mining": 0.001, + "diversified_support_services": 0.001, + "drug_retail": 0, + "electric_utilities": 0.013, + "electrical_components_and_equipment": 0.009, + "electronic_components": 0.001, + "electronic_equipment_and_instruments": 0, + "electronic_manufacturing_services": 0, + "environmental_and_facilities_services": 0.003, + "fertilizers_and_agricultural_che": 0.001, + "financial_exchanges_and_data": 0.006, + "food_retail": 0.002, + "gas_utilities": 0, + "general_merchandise_stores": 0.002, + "health_care_distributors": 0.003, + "health_care_equipment": 0.014, + "health_care_facilities": 0.001, + "health_care_services": 0.004, + "health_care_supplies": 0.003, + "heavy_electrical_equipment": 0.001, + "highways_and_railtracks": 0.005, + "home_improvement_retail": 0.012, + "homebuilding": 0.002, + "hotels_resorts_and_cruise_lines": 0.004, + "household_products": 0.011, + "hypermarkets_and_super_centers": 0.016, + "independent_power_producers_and_energy_traders": 0.001, + "industrial_conglomerates": 0.005, + "industrial_machinery": 0.005, + "insurance_brokers": 0.005, + "integrated_oil_and_gas": 0.014, + "interactive_media_and_services": 0.067, + "internet_and_direct_marketing_retail": 0.043, + "internet_services_and_infrastruc": 0.004, + "investment_banking_and_brokerage": 0.01, + "it_consulting_and_other_services": 0.011, + "leisure_facilities": 0, + "leisure_products": 0.001, + "life_and_health_insurance": 0.003, + "life_sciences_tools_and_services": 0.014, + "managed_health_care": 0.013, + "metal_and_glass_containers": 0.001, + "movies_and_entertainment": 0.012, + "multiutilities": 0.006, + "oil_and_gas_equipment_and_services": 0.002, + "oil_and_gas_exploration_and_production": 0.007, + "oil_and_gas_refining_and_marketing": 0.003, + "oil_and_gas_storage_and_transporta": 0.004, + "packaged_foods_and_meats": 0.006, + "paper_packaging": 0.001, + "precious_metals_and_minerals": 0.001, + "property_and_casualty_insurance": 0.027, + "publishing_and_broadcasting": 0, + "railroads": 0.001, + "real_estate_services": 0.001, + "reinsurance": 0, + "reit": 0.019, + "renewable_energy_equipment": 0.001, + "research_and_consulting_services": 0.002, + "restaurants": 0.009, + "security_and_alarm_services": 0.004, + "semiconductors": 0.115, + "soft_drinks": 0.01, + "specialty_chemicals": 0.004, + "specialty_stores": 0.001, + "steel": 0.001, + "systems_software": 0.078, + "technology_hardware_storage_and_peripherals": 0.002, + "tobacco": 0.006, + "trading_companies_and_distributors": 0.002, + "trucking": 0.004, + "water_utilities": 0 + }, + "tax_classification": "Regulated Investment Company", + "total_expenses": 0.0945, + "transfer_agent": "State Street Bank and Trust Company", + "trustee": "State Street Global Advisors Trust Company" } ], "status": "OK" }, "schema": { "properties": { - "error": { - "description": "An optional error message for failed requests when available.", - "type": "string" - }, "next_url": { - "description": "If present, this value can be used to fetch the next page of data.", + "description": "If present, this value can be used to fetch the next page.", "type": "string" }, "request_id": { - "description": "The unique identifier for the request.", + "description": "A request id assigned by the server.", "type": "string" }, "results": { - "description": "The list of schedules for the specified product.", + "description": "The results for this request.", "items": { "properties": { - "product_code": { - "description": "The product code for the futures product to which this schedule applies.", + "administrator": { + "description": "The administrator of the ETF.", "type": "string" }, - "product_name": { - "description": "The name of the futures product to which this schedule applies.", + "advisor": { + "description": "The investment advisor of the ETF.", "type": "string" }, - "schedule": { + "asset_class": { + "description": "The primary type of assets held by the ETF, such as equities, bonds, commodities, or other securities.", + "type": "string" + }, + "aum": { + "description": "The total assets under management, representing the current market value of all assets held by the ETF.", + "format": "double", + "type": "number" + }, + "avg_daily_trading_volume": { + "description": "The average number of shares traded daily over the past month, indicating liquidity and investor interest.", + "format": "double", + "type": "number" + }, + "bid_ask_spread": { + "description": "The average intraday bid-ask spread as a percentage, calculated by dividing the spread by the lowest ask price sampled during the day.", + "format": "double", + "type": "number" + }, + "call_volume": { + "description": "Call options volume.", + "format": "double", + "type": "number" + }, + "category": { + "description": "The broad investment category that describes the ETF's investment focus and strategy.", + "type": "string" + }, + "composite_ticker": { + "description": "The stock ticker symbol used to identify this ETF product on exchanges.", + "type": "string" + }, + "coupon_exposure": { + "description": "Coupon exposure breakdown for fixed income ETFs.", "items": { "properties": { - "event": { - "description": "The market event for this schedule.", - "enum": [ - "pre_open", - "open", - "close", - "pause", - "post_close_pre_open" - ], + "key": { "type": "string" }, - "timestamp": { - "description": "The timestamp for this market event in Central Time.", - "format": "time", + "value": { + "format": "double", + "type": "number" + } + }, + "required": [ + "key", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "creation_fee": { + "description": "The fee for creating new shares of the ETF.", + "format": "double", + "type": "number" + }, + "creation_unit_size": { + "description": "The size of creation units for the ETF.", + "format": "double", + "type": "number" + }, + "currency_exposure": { + "description": "Currency exposure breakdown of the ETF.", + "items": { + "properties": { + "key": { "type": "string" + }, + "value": { + "format": "double", + "type": "number" } }, + "required": [ + "key", + "value" + ], "type": "object" }, "type": "array" }, - "session_end_date": { - "description": "The date on which the schedule's trading day ended (sometimes referred to as trading date) formatted as `YYYY-MM-DD`. Note that although there is no time component on this attribute, the day refers to Central Time.", + "custodian": { + "description": "The custodian of the ETF assets.", + "type": "string" + }, + "description": { + "description": "The official name and description of the ETF product.", + "type": "string" + }, + "development_class": { + "description": "The economic development classification of the markets the ETF invests in, such as developed, emerging, or frontier markets.", + "type": "string" + }, + "discount_premium": { + "description": "Discount or premium to net asset value.", + "format": "double", + "type": "number" + }, + "distribution_frequency": { + "description": "How frequently the ETF makes distributions.", + "type": "string" + }, + "distributor": { + "description": "The distributor of the ETF.", + "type": "string" + }, + "effective_date": { + "description": "The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date.", "format": "date", "type": "string" }, - "trading_venue": { - "description": "The trading venue (MIC) for the exchange on which this schedule's product trades.", + "fee_waivers": { + "description": "Any fee waivers applied to the ETF.", + "format": "double", + "type": "number" + }, + "fiscal_year_end": { + "description": "The fiscal year end date for the ETF.", "type": "string" - } - }, - "type": "object", - "x-polygon-go-type": { - "name": "SchedulesResult" - } - }, - "type": "array" - }, - "status": { - "description": "The status of the response.", - "type": "string" - } - }, - "type": "object" - } - } - }, - "description": "A list of schedules for each product." - } - }, - "summary": "Product Schedules", - "tags": [ - "default" - ], - "x-polygon-entitlement-data-type": { - "description": "Reference data", - "name": "reference" - } - } - }, - "/futures/vX/quotes/{ticker}": { - "get": { - "description": "Get quotes for a contract in a given time range.", - "operationId": "GetFuturesQuotes", - "parameters": [ + }, + "focus": { + "description": "The specific investment focus or exposure that the ETF provides, such as sector, geography, or investment style.", + "type": "string" + }, + "futures_commission_merchant": { + "description": "The futures commission merchant, if applicable.", + "type": "string" + }, + "geographic_exposure": { + "description": "Geographic exposure breakdown of the ETF.", + "items": { + "properties": { + "key": { + "type": "string" + }, + "value": { + "format": "double", + "type": "number" + } + }, + "required": [ + "key", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "inception_date": { + "description": "The date when this ETF was first launched and became available for trading.", + "format": "date", + "type": "string" + }, + "industry_exposure": { + "description": "Industry exposure breakdown of the ETF.", + "items": { + "properties": { + "key": { + "type": "string" + }, + "value": { + "format": "double", + "type": "number" + } + }, + "required": [ + "key", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "industry_group_exposure": { + "description": "Industry group exposure breakdown of the ETF.", + "items": { + "properties": { + "key": { + "type": "string" + }, + "value": { + "format": "double", + "type": "number" + } + }, + "required": [ + "key", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "issuer": { + "description": "The financial institution or fund company that created and sponsors this ETF.", + "type": "string" + }, + "lead_market_maker": { + "description": "The lead market maker for the ETF.", + "type": "string" + }, + "leverage_style": { + "description": "Indicates whether the ETF uses leverage to amplify returns ('leveraged'), or does not use leverage ('unleveraged').", + "type": "string" + }, + "levered_amount": { + "description": "The leverage multiplier applied by the ETF, where positive numbers indicate leveraged exposure and negative numbers indicate inverse exposure.", + "format": "double", + "type": "number" + }, + "listing_exchange": { + "description": "The primary exchange where the ETF is listed.", + "type": "string" + }, + "management_classification": { + "description": "Defines whether an ETF is considered active under SEC rules, with managers making investment decisions, or passive, tracking an index.", + "type": "string" + }, + "management_fee": { + "description": "The annual fee charged by the fund manager for managing the ETF's portfolio and operations.", + "format": "double", + "type": "number" + }, + "maturity_exposure": { + "description": "Maturity exposure breakdown for fixed income ETFs.", + "items": { + "properties": { + "key": { + "type": "string" + }, + "value": { + "format": "double", + "type": "number" + } + }, + "required": [ + "key", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "net_expenses": { + "description": "Net expenses after waivers.", + "format": "double", + "type": "number" + }, + "num_holdings": { + "description": "Number of holdings in the ETF.", + "format": "double", + "type": "number" + }, + "options_available": { + "description": "Availability of options on the ETF.", + "format": "int32", + "type": "integer" + }, + "options_volume": { + "description": "Options trading volume for the ETF.", + "format": "double", + "type": "number" + }, + "other_expenses": { + "description": "Other expenses charged by the ETF.", + "format": "double", + "type": "number" + }, + "portfolio_manager": { + "description": "The portfolio manager of the ETF.", + "type": "string" + }, + "primary_benchmark": { + "description": "The main index or benchmark that this ETF is designed to track or replicate.", + "type": "string" + }, + "processed_date": { + "description": "The date showing when ETF Global received and processed the data.", + "format": "date", + "type": "string" + }, + "product_type": { + "description": "Indicates whether the product is an Exchange-Traded Note ('etn') or an Exchange-Traded Fund ('etf').", + "type": "string" + }, + "put_call_ratio": { + "description": "Put/call ratio for options on the ETF.", + "format": "double", + "type": "number" + }, + "put_volume": { + "description": "Put options volume.", + "format": "double", + "type": "number" + }, + "region": { + "description": "The geographic region or area of the world where the ETF concentrates its investments.", + "type": "string" + }, + "sector_exposure": { + "description": "Sector exposure breakdown of the ETF.", + "items": { + "properties": { + "key": { + "type": "string" + }, + "value": { + "format": "double", + "type": "number" + } + }, + "required": [ + "key", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "short_interest": { + "description": "Short interest in the ETF.", + "format": "double", + "type": "number" + }, + "subadvisor": { + "description": "The subadvisor of the ETF, if applicable.", + "type": "string" + }, + "subindustry_exposure": { + "description": "Sub-industry exposure breakdown of the ETF.", + "items": { + "properties": { + "key": { + "type": "string" + }, + "value": { + "format": "double", + "type": "number" + } + }, + "required": [ + "key", + "value" + ], + "type": "object" + }, + "type": "array" + }, + "tax_classification": { + "description": "The tax structure of the ETF, determining whether investors receive 1099 or K1 tax forms (RIC, Partnership, or UIT).", + "type": "string" + }, + "total_expenses": { + "description": "The total annual expense ratio of the ETF, including all fees and costs passed on to investors.", + "format": "double", + "type": "number" + }, + "transfer_agent": { + "description": "The transfer agent for the ETF.", + "type": "string" + }, + "trustee": { + "description": "The trustee of the ETF.", + "type": "string" + } + }, + "required": [ + "product_type", + "leverage_style", + "management_classification" + ], + "type": "object" + }, + "type": "array" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "OK" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "results" + ], + "type": "object" + } + } + }, + "description": "A list of results." + }, + "400": { + "content": { + "application/json": { + "schema": { + "properties": { + "error": { + "description": "A message describing the source of the error.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "ERROR" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "error" + ], + "type": "object" + } + } + }, + "description": "An error message." + } + }, + "tags": [ + "default" + ] + } + }, + "/etf-global/v1/taxonomies": { + "get": { + "description": "ETF Global taxonomy data containing detailed classification and categorization information for ETFs including investment strategy, methodology, and structural characteristics.", + "operationId": "get_etf-global_v1_taxonomies", + "parameters": [ + { + "description": "The date showing when ETF Global received and processed the data. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "processed_date", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "processed_date.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "processed_date.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "processed_date.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "processed_date.lte", + "schema": { + "type": "string" + } + }, + { + "description": "The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "effective_date", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "effective_date.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "effective_date.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "effective_date.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "effective_date.lte", + "schema": { + "type": "string" + } + }, + { + "description": "The stock ticker symbol used to identify this ETF product on exchanges.", + "in": "query", + "name": "composite_ticker", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "composite_ticker.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "composite_ticker.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "composite_ticker.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "composite_ticker.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "composite_ticker.lte", + "schema": { + "type": "string" + } + }, + { + "description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'.", + "in": "query", + "name": "limit", + "schema": { + "default": 100, + "maximum": 5001, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'composite_ticker' if not specified. The sort order defaults to 'asc' if not specified.", + "in": "query", + "name": "sort", + "schema": { + "default": "composite_ticker.asc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "count": 1, + "request_id": 1, + "results": [ + { + "asset_class": "Equity", + "category": "Size and Style", + "composite_ticker": "SPY", + "country": "U.S.", + "description": "SPDR S&P 500 ETF Trust", + "development_class": "Developed Markets", + "effective_date": "2025-09-19", + "exposure_mechanism": "Blended Replication", + "factor": "Size", + "focus": "Large Cap", + "holdings_disclosure_frequency": "Daily", + "inception_date": "1993-01-22", + "isin": "US78462F1030", + "issuer": "SSgA", + "leverage_style": "unleveraged", + "levered_amount": 0, + "management_classification": "passive", + "management_style": "Passive - Representative Sampling", + "objective": "Index-Tracking", + "primary_benchmark": "S&P 500 Index", + "processed_date": "2025-09-19", + "product_type": "etf", + "rebalance_frequency": "Quarterly", + "reconstitution_frequency": "Quarterly", + "region": "North America", + "selection_methodology": "Modified Market Cap, Fundamental Multifactor, Liquidity", + "selection_universe": "U.S. Large Caps", + "strategic_focus": "Factor", + "targeted_focus": "Size", + "tax_classification": "Regulated Investment Company", + "us_code": "78462F103", + "weighting_methodology": "Modified Market Capitalization-Weighted" + } + ], + "status": "OK" + }, + "schema": { + "properties": { + "next_url": { + "description": "If present, this value can be used to fetch the next page.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "results": { + "description": "The results for this request.", + "items": { + "properties": { + "asset_class": { + "description": "The primary type of assets held by the ETF, such as equities, bonds, commodities, or other securities.", + "type": "string" + }, + "category": { + "description": "The broad investment category that describes the ETF's investment focus and strategy.", + "type": "string" + }, + "composite_ticker": { + "description": "The stock ticker symbol used to identify this ETF product on exchanges.", + "type": "string" + }, + "country": { + "description": "The specific country focus of the ETF, if applicable.", + "type": "string" + }, + "credit_quality_rating": { + "description": "Credit quality rating for fixed income ETFs.", + "type": "string" + }, + "description": { + "description": "The official name and description of the ETF product.", + "type": "string" + }, + "development_class": { + "description": "The economic development classification of the markets the ETF invests in, such as developed, emerging, or frontier markets.", + "type": "string" + }, + "duration": { + "description": "The duration characteristics for fixed income ETFs.", + "type": "string" + }, + "effective_date": { + "description": "The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date.", + "format": "date", + "type": "string" + }, + "esg": { + "description": "Environmental, Social, and Governance characteristics.", + "type": "string" + }, + "exposure_mechanism": { + "description": "The mechanism used to achieve exposure.", + "type": "string" + }, + "factor": { + "description": "Factor exposure characteristics of the ETF.", + "type": "string" + }, + "focus": { + "description": "The specific investment focus or exposure that the ETF provides, such as sector, geography, or investment style.", + "type": "string" + }, + "hedge_reset": { + "description": "The frequency of hedge reset, if applicable.", + "type": "string" + }, + "holdings_disclosure_frequency": { + "description": "How frequently holdings are disclosed.", + "type": "string" + }, + "inception_date": { + "description": "The date when this ETF was first launched and became available for trading.", + "format": "date", + "type": "string" + }, + "isin": { + "description": "The International Securities Identification Number, a global standard code for uniquely identifying this ETF worldwide.", + "type": "string" + }, + "issuer": { + "description": "The financial institution or fund company that created and sponsors this ETF.", + "type": "string" + }, + "leverage_reset": { + "description": "The frequency of leverage reset, if applicable.", + "type": "string" + }, + "leverage_style": { + "description": "Indicates whether the ETF uses leverage to amplify returns ('leveraged'), or does not use leverage ('unleveraged').", + "type": "string" + }, + "levered_amount": { + "description": "The leverage multiplier applied by the ETF, where positive numbers indicate leveraged exposure and negative numbers indicate inverse exposure.", + "format": "double", + "type": "number" + }, + "management_classification": { + "description": "Defines whether an ETF is considered active under SEC rules, with managers making investment decisions, or passive, tracking an index.", + "type": "string" + }, + "management_style": { + "description": "Indicates whether an ETF is managed actively or passively, and the level of transparency or replication method used.", + "type": "string" + }, + "maturity": { + "description": "The maturity profile for fixed income ETFs.", + "type": "string" + }, + "objective": { + "description": "The primary investment objective of the ETF.", + "type": "string" + }, + "primary_benchmark": { + "description": "The main index or benchmark that this ETF is designed to track or replicate.", + "type": "string" + }, + "processed_date": { + "description": "The date showing when ETF Global received and processed the data.", + "format": "date", + "type": "string" + }, + "product_type": { + "description": "Indicates whether the product is an Exchange-Traded Note ('etn') or an Exchange-Traded Fund ('etf').", + "type": "string" + }, + "rebalance_frequency": { + "description": "How frequently the ETF rebalances its holdings.", + "type": "string" + }, + "reconstitution_frequency": { + "description": "How frequently the index is reconstituted.", + "type": "string" + }, + "region": { + "description": "The geographic region or area of the world where the ETF concentrates its investments.", + "type": "string" + }, + "secondary_objective": { + "description": "The secondary investment objective, if applicable.", + "type": "string" + }, + "selection_methodology": { + "description": "The methodology used to select securities.", + "type": "string" + }, + "selection_universe": { + "description": "The universe from which securities are selected.", + "type": "string" + }, + "strategic_focus": { + "description": "The strategic investment focus of the ETF.", + "type": "string" + }, + "targeted_focus": { + "description": "The targeted investment focus of the ETF.", + "type": "string" + }, + "tax_classification": { + "description": "The tax structure of the ETF, determining whether investors receive 1099 or K1 tax forms (RIC, Partnership, or UIT).", + "type": "string" + }, + "us_code": { + "description": "A unique identifier code that identifies this ETF in US markets.", + "type": "string" + }, + "weighting_methodology": { + "description": "The methodology used to weight holdings.", + "type": "string" + } + }, + "required": [ + "product_type", + "leverage_style", + "management_classification" + ], + "type": "object" + }, + "type": "array" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "OK" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "results" + ], + "type": "object" + } + } + }, + "description": "A list of results." + }, + "400": { + "content": { + "application/json": { + "schema": { + "properties": { + "error": { + "description": "A message describing the source of the error.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "ERROR" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "error" + ], + "type": "object" + } + } + }, + "description": "An error message." + } + }, + "tags": [ + "default" + ] + } + }, + "/fed/v1/inflation": { + "get": { + "description": "A table tracking inflation and price indices, including Consumer Price Index (CPI) and Personal Consumption Expenditures (PCE) metrics over time.", + "operationId": "get_fed_v1_inflation", + "parameters": [ + { + "description": "Calendar date of the observation (YYYY‑MM‑DD).", + "in": "query", + "name": "date", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "date.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "date.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "date.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "date.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "date.lte", + "schema": { + "type": "string" + } + }, + { + "description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.", + "in": "query", + "name": "limit", + "schema": { + "default": 100, + "maximum": 50001, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'asc' if not specified.", + "in": "query", + "name": "sort", + "schema": { + "default": "date.asc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "count": 1, + "request_id": 1, + "results": [ + { + "cpi": 310.45, + "cpi_core": 320.1, + "cpi_year_over_year": 3.18, + "date": "2025-06-01", + "pce": 132.73, + "pce_core": 131.9, + "pce_spending": 20345.6 + } + ], + "status": "OK" + }, + "schema": { + "properties": { + "next_url": { + "description": "If present, this value can be used to fetch the next page.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "results": { + "description": "The results for this request.", + "items": { + "properties": { + "cpi": { + "description": "Consumer Price Index (CPI) for All Urban Consumers — a standard measure of headline inflation based on a fixed basket of goods and services, not seasonally adjusted.", + "format": "float", + "type": "number" + }, + "cpi_core": { + "description": "Core Consumer Price Index — the CPI excluding food and energy, used to understand underlying inflation trends without short-term volatility.", + "format": "float", + "type": "number" + }, + "cpi_year_over_year": { + "description": "Year-over-year percentage change in the headline CPI — the most commonly cited inflation rate in public discourse and economic policy.", + "format": "float", + "type": "number" + }, + "date": { + "description": "Calendar date of the observation (YYYY‑MM‑DD).", + "type": "string" + }, + "pce": { + "description": "Personal Consumption Expenditures (PCE) Price Index — a broader measure of inflation used by the Federal Reserve, reflecting actual consumer spending patterns and updated basket weights.", + "format": "float", + "type": "number" + }, + "pce_core": { + "description": "Core PCE Price Index — excludes food and energy prices from the PCE index, and is the Fed's preferred measure of underlying inflation.", + "format": "float", + "type": "number" + }, + "pce_spending": { + "description": "Nominal Personal Consumption Expenditures — total dollar value of consumer spending in the U.S. economy, reported in billions of dollars and not adjusted for inflation.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "type": "array" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "OK" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "results" + ], + "type": "object" + } + } + }, + "description": "A list of results." + }, + "400": { + "content": { + "application/json": { + "schema": { + "properties": { + "error": { + "description": "A message describing the source of the error.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "ERROR" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "error" + ], + "type": "object" + } + } + }, + "description": "An error message." + } + }, + "tags": [ + "default" + ] + } + }, + "/fed/v1/inflation-expectations": { + "get": { + "description": "A table tracking inflation expectations from both market-based and economic model perspectives across different time horizons.", + "operationId": "get_fed_v1_inflation-expectations", + "parameters": [ + { + "description": "Calendar date of the observation (YYYY‑MM‑DD).", + "in": "query", + "name": "date", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "date.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "date.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "date.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "date.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "date.lte", + "schema": { + "type": "string" + } + }, + { + "description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.", + "in": "query", + "name": "limit", + "schema": { + "default": 100, + "maximum": 50001, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'asc' if not specified.", + "in": "query", + "name": "sort", + "schema": { + "default": "date.asc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "count": 1, + "request_id": 1, + "results": [ + { + "date": "2025-06-17", + "forward_years_5_to_10": 2.6, + "market_10_year": 2.36, + "market_5_year": 2.12, + "model_10_year": 2.95, + "model_1_year": 2.85, + "model_30_year": 3, + "model_5_year": 2.91 + } + ], + "status": "OK" + }, + "schema": { + "properties": { + "next_url": { + "description": "If present, this value can be used to fetch the next page.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "results": { + "description": "The results for this request.", + "items": { + "properties": { + "date": { + "description": "Calendar date of the observation (YYYY‑MM‑DD).", + "type": "string" + }, + "forward_years_5_to_10": { + "description": "5-Year, 5-Year Forward Inflation Expectation Rate — the market's expectation of average annual inflation for the 5-year period beginning 5 years from now, based on the spread between forward nominal and real yields.", + "format": "float", + "type": "number" + }, + "market_10_year": { + "description": "10-Year Breakeven Inflation Rate — the market's expectation of average annual inflation over the next 10 years, based on the spread between 10-year nominal Treasury yields and 10-year TIPS yields.", + "format": "float", + "type": "number" + }, + "market_5_year": { + "description": "5-Year Breakeven Inflation Rate — the market's expectation of average annual inflation over the next 5 years, based on the spread between 5-year nominal Treasury yields and 5-year TIPS yields.", + "format": "float", + "type": "number" + }, + "model_10_year": { + "description": "The Cleveland Fed’s 10-year inflation expectations data estimated expected inflation, risk premiums, and the real interest rate using a model based on Treasury yields, inflation data, swaps, and surveys.", + "format": "float", + "type": "number" + }, + "model_1_year": { + "description": "The Cleveland Fed’s 1-year inflation expectations data estimated expected inflation, risk premiums, and the real interest rate using a model based on Treasury yields, inflation data, swaps, and surveys.", + "format": "float", + "type": "number" + }, + "model_30_year": { + "description": "The Cleveland Fed’s 30-year inflation expectations data estimated expected inflation, risk premiums, and the real interest rate using a model based on Treasury yields, inflation data, swaps, and surveys.", + "format": "float", + "type": "number" + }, + "model_5_year": { + "description": "The Cleveland Fed’s 5-year inflation expectations data estimated expected inflation, risk premiums, and the real interest rate using a model based on Treasury yields, inflation data, swaps, and surveys.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "type": "array" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "OK" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "results" + ], + "type": "object" + } + } + }, + "description": "A list of results." + }, + "400": { + "content": { + "application/json": { + "schema": { + "properties": { + "error": { + "description": "A message describing the source of the error.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "ERROR" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "error" + ], + "type": "object" + } + } + }, + "description": "An error message." + } + }, + "tags": [ + "default" + ] + } + }, + "/fed/v1/treasury-yields": { + "get": { + "description": "A record of U.S. Treasury bond yields across various maturity periods, tracking historical interest rates from short-term to long-term government securities.", + "operationId": "get_fed_v1_treasury-yields", + "parameters": [ + { + "description": "Calendar date of the yield observation (YYYY-MM-DD).", + "in": "query", + "name": "date", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "date.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "date.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "date.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "date.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "date.lte", + "schema": { + "type": "string" + } + }, + { + "description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.", + "in": "query", + "name": "limit", + "schema": { + "default": 100, + "maximum": 50001, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'asc' if not specified.", + "in": "query", + "name": "sort", + "schema": { + "default": "date.asc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "count": 1, + "request_id": 1, + "results": [ + { + "date": "1962-01-02", + "yield_10_year": 4.06, + "yield_1_year": 3.22, + "yield_5_year": 3.88 + } + ], + "status": "OK" + }, + "schema": { + "properties": { + "next_url": { + "description": "If present, this value can be used to fetch the next page.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "results": { + "description": "The results for this request.", + "items": { + "properties": { + "date": { + "description": "Calendar date of the yield observation (YYYY-MM-DD).", + "type": "string" + }, + "yield_10_year": { + "description": "Market Yield on U.S. Treasury Securities at 10-Year Constant Maturity, Quoted on an Investment Basis", + "format": "float", + "type": "number" + }, + "yield_1_month": { + "description": "Market Yield on U.S. Treasury Securities at 1-Month Constant Maturity, Quoted on an Investment Basis", + "format": "float", + "type": "number" + }, + "yield_1_year": { + "description": "Market Yield on U.S. Treasury Securities at 1-Year Constant Maturity, Quoted on an Investment Basis", + "format": "float", + "type": "number" + }, + "yield_20_year": { + "description": "Market Yield on U.S. Treasury Securities at 20-Year Constant Maturity, Quoted on an Investment Basis", + "format": "float", + "type": "number" + }, + "yield_2_year": { + "description": "Market Yield on U.S. Treasury Securities at 2-Year Constant Maturity, Quoted on an Investment Basis", + "format": "float", + "type": "number" + }, + "yield_30_year": { + "description": "Market Yield on U.S. Treasury Securities at 30-Year Constant Maturity, Quoted on an Investment Basis", + "format": "float", + "type": "number" + }, + "yield_3_month": { + "description": "Market Yield on U.S. Treasury Securities at 3-Month Constant Maturity, Quoted on an Investment Basis", + "format": "float", + "type": "number" + }, + "yield_3_year": { + "description": "Market Yield on U.S. Treasury Securities at 3-Year Constant Maturity, Quoted on an Investment Basis", + "format": "float", + "type": "number" + }, + "yield_5_year": { + "description": "Market Yield on U.S. Treasury Securities at 5-Year Constant Maturity, Quoted on an Investment Basis", + "format": "float", + "type": "number" + }, + "yield_6_month": { + "description": "Market Yield on U.S. Treasury Securities at 6-Month Constant Maturity, Quoted on an Investment Basis", + "format": "float", + "type": "number" + }, + "yield_7_year": { + "description": "Market Yield on U.S. Treasury Securities at 7-Year Constant Maturity, Quoted on an Investment Basis", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "type": "array" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "OK" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "results" + ], + "type": "object" + } + } + }, + "description": "A list of results." + }, + "400": { + "content": { + "application/json": { + "schema": { + "properties": { + "error": { + "description": "A message describing the source of the error.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "ERROR" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "error" + ], + "type": "object" + } + } + }, + "description": "An error message." + } + }, + "tags": [ + "default" + ] + } + }, + "/forex/v1/exchanges": { + "get": { + "description": "Global foreign exchange (FX) trading venues and market infrastructure, including electronic trading platforms, banks, and other institutions facilitating currency pair trading worldwide.", + "operationId": "get_forex_v1_exchanges", + "parameters": [ + { + "description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '999'.", + "in": "query", + "name": "limit", + "schema": { + "default": 100, + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "count": 1, + "request_id": 1, + "results": [ + { + "id": "48", + "name": "Currency Banks 1", + "type": "exchange" + } + ], + "status": "OK" + }, + "schema": { + "properties": { + "next_url": { + "description": "If present, this value can be used to fetch the next page.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "results": { + "description": "The results for this request.", + "items": { + "properties": { + "id": { + "description": "Numeric identifier for the forex trading venue or institution.", + "type": "string" + }, + "name": { + "description": "Full name of the foreign exchange trading venue, platform, or financial institution.", + "type": "string" + }, + "type": { + "description": "Type of forex venue - 'exchange' for electronic trading platforms and institutional trading venues.", + "type": "string" + } + }, + "required": [ + "id", + "type", + "name" + ], + "type": "object" + }, + "type": "array" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "OK" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "results" + ], + "type": "object" + } + } + }, + "description": "A list of results." + }, + "400": { + "content": { + "application/json": { + "schema": { + "properties": { + "error": { + "description": "A message describing the source of the error.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "ERROR" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "error" + ], + "type": "object" + } + } + }, + "description": "An error message." + } + }, + "tags": [ + "default" + ] + } + }, + "/futures/vX/aggs/{ticker}": { + "get": { + "description": "Get aggregates for a contract in a given time range.", + "operationId": "GetFuturesAggregates", + "parameters": [ + { + "description": "The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract).", + "example": "GCJ5", + "in": "path", + "name": "ticker", + "required": true, + "schema": { + "type": "string" + }, + "x-polygon-go-id": "Ticker" + }, + { + "description": "This sets the size of the aggregate windows. It accepts custom values that specify the granularity and the duration of the window.\nFor example: 15mins, 30secs, 12hours, or 7days.\nThere are maximum allowable candle sizes. For example, you can request \"1min\" to \"59mins\", but after that you will need to use \"1hr\". If you make a request for a candle size that is not supported, we will return a 400 \"Bad Request - resolution value is not allowed.\"", + "example": "1min", + "in": "query", + "name": "resolution", + "schema": { + "default": "1day", + "type": "string" + } + }, + { + "description": "Specifies the start time of the aggregate (OHLC) candles you want returned (YYYY-MM-DD date or nanosecond Unix timestamp).\nHow it works - If not provided, the API returns the most recent candles available, up to the limit you set. - If provided, the value determines which candle(s) to return. The timestamp or date is “snapped” to the start time of the matching candle interval. - You can use comparison operators to form ranges:\n - `window_start.gte` – greater than or equal to\n - `window_start.gt` – greater than\n - `window_start.lte` – less than or equal to\n - `window_start.lt` – less than\n\nExamples 1. Most recent minute candles\n `/vX/aggs/ESU5?resolution=1min&limit=5`\n\n2. Daily candle for August 5, 2025\n `/vX/aggs/ESU5?resolution=1day&window_start=2025-08-05`\n\n3. Daily candles from July 1–31, 2025\n `/vX/aggs/ESU5?resolution=1day&window_start.gte=2025-07-01&window_start.lte=2025-07-31`\n\n4. 1,000 one-second candles after a specific timestamp\n `/vX/aggs/ESU5?resolution=1sec&window_start.gt=1751409877000000000&limit=1000`", + "in": "query", + "name": "window_start", + "schema": { + "type": "string" + }, + "x-polygon-filter-field": { + "range": true + } + }, + { + "description": "The number of results to return per page (default=1000, maximum=50000, minimum=1).", + "in": "query", + "name": "limit", + "schema": { + "default": 1000, + "maximum": 50000, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "Range by window_start.", + "in": "query", + "name": "window_start.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Range by window_start.", + "in": "query", + "name": "window_start.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Range by window_start.", + "in": "query", + "name": "window_start.lte", + "schema": { + "type": "string" + } + }, + { + "description": "Range by window_start.", + "in": "query", + "name": "window_start.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Sort results by field and direction using dotted notation (e.g., 'ticker.asc', 'name.desc').", + "in": "query", + "name": "sort", + "schema": { + "default": "window_start.desc", + "enum": [ + "window_start.asc", + "window_start.desc" + ], + "example": "window_start.desc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "request_id": "b452e45b7eaad14151c3e1ce5129b558", + "results": [ + { + "close": 2874.2, + "dollar_volume": 380560636.01, + "high": 2877.1, + "low": 2837.4, + "open": 2849.8, + "session_end_date": "2025-02-04", + "settlement_price": 2875.8, + "ticker": "GCJ5", + "transactions": 74223, + "volume": 133072, + "window_start": 1738627200000000000 + }, + { + "close": 2884.8, + "dollar_volume": 448429944.1, + "high": 2906, + "low": 2870.1, + "open": 2873.7, + "session_end_date": "2025-02-05", + "settlement_price": 2893, + "ticker": "GCJ5", + "transactions": 83673, + "volume": 155170, + "window_start": 1738713600000000000 + } + ], + "status": "OK" + }, + "schema": { + "properties": { + "next_url": { + "description": "If present, the URL to the next page of results.", + "type": "string" + }, + "results": { + "items": { + "properties": { + "close": { + "description": "The last price within the timeframe.", + "format": "double", + "type": "number" + }, + "dollar_volume": { + "description": "The total dollar volume of the transactions that occurred within the timeframe.", + "format": "double", + "type": "number" + }, + "high": { + "description": "The highest price within the timeframe.", + "format": "double", + "type": "number" + }, + "low": { + "description": "The lowest price within the timeframe.", + "format": "double", + "type": "number" + }, + "open": { + "description": "The opening price within the timeframe.", + "format": "double", + "type": "number" + }, + "session_end_date": { + "description": "Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format.", + "type": "string" + }, + "settlement_price": { + "description": "The price the contract would have cost to settle for this session.", + "format": "double", + "type": "number" + }, + "ticker": { + "description": "The ticker for the contract.", + "type": "string" + }, + "transactions": { + "description": "The number of transactions that occurred within the timeframe.", + "format": "int64", + "type": "integer" + }, + "volume": { + "description": "The number of contracts that traded within the timeframe.", + "format": "int64", + "type": "integer" + }, + "window_start": { + "description": "The timestamp of the beginning of the candlestick’s aggregation window.", + "format": "int64", + "type": "integer", + "x-polygon-go-type": { + "name": "INanoseconds", + "path": "github.com/polygon-io/ptime" + } + } + }, + "required": [ + "ticker", + "window_start", + "session_end_date", + "open", + "high", + "low", + "close", + "transactions", + "volume", + "dollar_volume" + ], + "type": "object" + }, + "type": "array" + }, + "status": { + "description": "The status of the response.", + "type": "string" + } + }, + "required": [ + "status", + "results" + ], + "type": "object" + } + } + }, + "description": "A list of aggregates." + } + }, + "summary": "Aggregates", + "tags": [ + "default" + ], + "x-polygon-entitlement-data-type": { + "description": "Aggregate data", + "name": "aggregates" + }, + "x-polygon-entitlement-market-type": { + "description": "Futures data", + "name": "futures" + } + } + }, + "/futures/vX/contracts": { + "get": { + "description": "The Contracts endpoint returns a list of futures contracts. This endpoint can be used to query for contracts based on a variety of parameters, including the contract's ticker, product code, first trade date, last trade date, and whether or not the contract was active on a given date.", + "operationId": "GetFuturesContracts", + "parameters": [ + { + "description": "A unique identifier for the Product a Contract belongs to. Note that multiple contracts can belong to the same product.", + "in": "query", + "name": "product_code", + "schema": { + "type": "string" + } + }, + { + "description": "The first day that a contract was tradeable. A date with the format YYYY-MM-DD.", + "in": "query", + "name": "first_trade_date", + "schema": { + "format": "date", + "type": "string" + } + }, + { + "description": "The last day that the contract was tradeable. A date with the format YYYY-MM-DD.", + "in": "query", + "name": "last_trade_date", + "schema": { + "format": "date", + "type": "string" + } + }, + { + "description": "Specify the point-in-time for which you want to retrieve information. Note that the contract data returned for a given date is the state of that contract as of that day. A date in the format YYYY-MM-DD (default=today).", + "in": "query", + "name": "as_of", + "schema": { + "format": "date", + "type": "string" + } + }, + { + "description": "Filter for contracts based on whether or not they were tradeable at the given point in time. For example, if the date queried is greater-than or equal-to a contract's 'first_trade_date' and less-than-or-equal-to its 'last_trade_date', then the contract was active. If the date queried is greater-than-or-equal-to the contract's 'last_trade_date' or less-than-or-equal-to its 'first_trade_date', then the contract was inactive.", + "in": "query", + "name": "active", + "schema": { + "default": "all", + "enum": [ + "all", + "true", + "false" + ], + "type": "string" + } + }, + { + "description": "The type of contract, one of \"all\", \"single\", or \"combo\" (default=all).", + "in": "query", + "name": "type", + "schema": { + "default": "all", + "enum": [ + "all", + "single", + "combo" + ], + "type": "string" + } + }, + { + "description": "The number of results to return per page (default=100, max=1000, min=1).", + "in": "query", + "name": "limit", + "schema": { + "default": 100, + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "Sort results by field and direction using dotted notation (e.g., 'ticker.asc', 'name.desc').", + "in": "query", + "name": "sort", + "schema": { + "default": "product_code.asc", + "enum": [ + "product_code.asc", + "product_code.desc", + "first_trade_date.asc", + "first_trade_date.desc", + "last_trade_date.asc", + "last_trade_date.desc" + ], + "example": "product_code.asc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "next_url": "https://api.massive.com/futures/vX/contracts?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "request_id": "000a000a0a0a000a0a0aa00a0a0000a0", + "results": [ + { + "active": true, + "as_of": "2025-02-26", + "days_to_maturity": 138, + "first_trade_date": "2025-01-15", + "last_trade_date": "2025-07-14", + "max_order_quantity": 1999, + "min_order_quantity": 1, + "name": "00CN5 Future", + "product_code": "00C", + "settlement_date": "2025-07-14", + "settlement_tick_size": 0.0025, + "spread_tick_size": 0.0025, + "ticker": "00CN5", + "trade_tick_size": 0.0025, + "trading_venue": "XCBT", + "type": "single" + }, + { + "active": false, + "as_of": "2025-02-26", + "days_to_maturity": -12, + "first_trade_date": "2024-09-16", + "last_trade_date": "2025-02-14", + "max_order_quantity": 1999, + "min_order_quantity": 1, + "name": "00CG5 Future", + "product_code": "00C", + "settlement_date": "2025-02-14", + "ticker": "00CG5XXX", + "trading_venue": "XCBT", + "type": "single" + } + ], + "status": "OK" + }, + "schema": { + "properties": { + "next_url": { + "description": "If present, this value can be used to fetch the next page of data.", + "type": "string" + }, + "request_id": { + "description": "A unique identifier for this request.", + "type": "string" + }, + "results": { + "items": { + "properties": { + "active": { + "description": "Whether or not this contract was tradeable at the given point-in-time specified in the 'as_of' attribute (a contract was active if the given day was after the 'first_trade_date' and before the 'last_trade_date').", + "type": "boolean" + }, + "as_of": { + "description": "The point-in-time date for the given contract - e.g. if 'as_of' is set to 2021-04-25, then the data retrieved describes the contract(s) as of 2021-04-25.", + "format": "date", + "type": "string" + }, + "days_to_maturity": { + "description": "The number of days until this contract matures (since the point-in-time date). Note that the absence of this field means there are 0 days until maturity.", + "type": "integer" + }, + "first_trade_date": { + "description": "The date on which this contract first became tradeable.", + "format": "date", + "type": "string" + }, + "last_trade_date": { + "description": "The date on which this contract last became tradeable.", + "format": "date", + "type": "string" + }, + "maturity": { + "description": "This field provides the calendar month reflected in the instrument symbol. For futures spreads and options spreads, this field contains the first leg's calendar month reflected in the instrument symbol. For daily products, this tag contains the full calendar date (YYYYMMDD) as reflected in the instrument symbol.", + "type": "string" + }, + "max_order_quantity": { + "description": "The maximum order quantity for this contract.", + "type": "integer" + }, + "min_order_quantity": { + "description": "The minimum order quantity for this contract.", + "type": "integer" + }, + "name": { + "description": "The name of the contract.", + "type": "string" + }, + "product_code": { + "description": "The unique identifier for the product to which this contract belongs.", + "type": "string" + }, + "settlement_date": { + "description": "The final settlement date for the contract.", + "format": "date", + "type": "string" + }, + "settlement_tick_size": { + "description": "The settlement tick size for this contract.", + "type": "number" + }, + "spread_tick_size": { + "description": "The spread tick size for this contract.", + "type": "number" + }, + "ticker": { + "description": "The unique identifier for the contract, typically consisting of the product code and expiration date.", + "type": "string" + }, + "trade_tick_size": { + "description": "The tick size for this contract.", + "type": "number" + }, + "trading_venue": { + "description": "The trading venue (MIC) for the exchange on which this contract trades.", + "type": "string" + }, + "type": { + "description": "The type of contract, one of \"single\" or \"combo\".", + "type": "string" + } + }, + "required": [ + "ticker", + "product_code", + "first_trade_date", + "last_trade_date", + "trading_venue", + "active", + "type" + ], + "type": "object", + "x-polygon-go-type": { + "name": "Contract" + } + }, + "type": "array" + }, + "status": { + "description": "The status of this request's response.", + "example": "OK", + "type": "string" + } + }, + "required": [ + "status", + "request_id" + ], + "type": "object" + } + } + }, + "description": "A list of contracts which satify all query parameters." + } + }, + "summary": "Contracts", + "tags": [ + "default" + ], + "x-polygon-entitlement-data-type": { + "description": "Reference data", + "name": "reference" + } + } + }, + "/futures/vX/contracts-new": { + "get": { + "description": "Retrieve detailed information about a specific futures contract identified by its ticker. The response includes comprehensive attributes such as active status, trade dates, days to maturity, exchange code, order quantity limits, settlement date, tick sizes, and other key metrics. Users can specify a point-in-time (as_of) to view the contract's state on a particular date, supporting informed trading decisions and historical analysis.\n\nUse Cases: Contract specification, historical product checks, system integration, trading decision support.", + "operationId": "get_futures_vX_contracts-new", + "parameters": [ + { + "description": "A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about products for the specified day (default=today). Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "date", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "date.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "date.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "date.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "date.lte", + "schema": { + "type": "string" + } + }, + { + "description": "The unique identifier for the product.", + "in": "query", + "name": "product_code", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "product_code.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "product_code.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "product_code.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "product_code.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "product_code.lte", + "schema": { + "type": "string" + } + }, + { + "description": "The ticker for the contract.", + "in": "query", + "name": "ticker", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "ticker.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "ticker.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "ticker.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "ticker.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "ticker.lte", + "schema": { + "type": "string" + } + }, + { + "description": "The contract is still trading. Value must be 'true', 'false', '1' or '0'.", + "in": "query", + "name": "active", + "schema": { + "type": "string" + } + }, + { + "description": "The type of product, one of 'single' or 'combo'.", + "in": "query", + "name": "type", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "type.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "type.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "type.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "type.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "type.lte", + "schema": { + "type": "string" + } + }, + { + "description": "The first date the contract trades. Value must be an integer timestamp in nanoseconds or formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "first_trade_date", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value. Value must be an integer timestamp in nanoseconds or formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "first_trade_date.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be an integer timestamp in nanoseconds or formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "first_trade_date.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value. Value must be an integer timestamp in nanoseconds or formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "first_trade_date.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value. Value must be an integer timestamp in nanoseconds or formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "first_trade_date.lte", + "schema": { + "type": "string" + } + }, + { + "description": "The last date the contract trades. Value must be an integer timestamp in nanoseconds or formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "last_trade_date", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value. Value must be an integer timestamp in nanoseconds or formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "last_trade_date.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be an integer timestamp in nanoseconds or formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "last_trade_date.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value. Value must be an integer timestamp in nanoseconds or formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "last_trade_date.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value. Value must be an integer timestamp in nanoseconds or formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "last_trade_date.lte", + "schema": { + "type": "string" + } + }, + { + "description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '1000'.", + "in": "query", + "name": "limit", + "schema": { + "default": 100, + "maximum": 1001, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'product_code' if not specified. The sort order defaults to 'asc' if not specified.", + "in": "query", + "name": "sort", + "schema": { + "default": "product_code.asc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "next_url": { + "description": "If present, this value can be used to fetch the next page.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "results": { + "description": "The results for this request.", + "items": { + "properties": { + "active": { + "description": "The contract is still trading.", + "type": "boolean" + }, + "date": { + "description": "A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about products for the specified day (default=today).", + "format": "date", + "type": "string" + }, + "days_to_maturity": { + "format": "int64", + "type": "integer" + }, + "first_trade_date": { + "description": "The first date the contract trades.", + "format": "int64", + "type": "integer" + }, + "group_code": { + "type": "string" + }, + "guid": { + "type": "string" + }, + "last_trade_date": { + "description": "The last date the contract trades.", + "format": "int64", + "type": "integer" + }, + "latest": { + "type": "boolean" + }, + "maturity_month": { + "type": "string" + }, + "max_order_quantity": { + "description": "The maximum order quantity.", + "type": "string" + }, + "min_order_quantity": { + "description": "The minimum order quantity.", + "type": "string" + }, + "name": { + "description": "The full name of the product.", + "type": "string" + }, + "product_code": { + "description": "The unique identifier for the product.", + "type": "string" + }, + "security_id": { + "type": "string" + }, + "settlement_date": { + "format": "int64", + "type": "integer" + }, + "settlement_tick_size": { + "description": "The tick size for settlement.", + "format": "double", + "type": "number" + }, + "spread_tick_size": { + "description": "The tick size for spreads.", + "format": "double", + "type": "number" + }, + "ticker": { + "description": "The ticker for the contract.", + "type": "string" + }, + "trade_tick_size": { + "description": "The tick size for trades.", + "format": "double", + "type": "number" + }, + "trading_venue": { + "description": "The trading venue (MIC) for the exchange on which this contract trades.", + "type": "string" + }, + "type": { + "description": "The type of product, one of 'single' or 'combo'.", + "type": "string" + }, + "year_month": { + "type": "string" + } + }, + "required": [ + "active", + "date", + "year_month" + ], + "type": "object" + }, + "type": "array" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "OK" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "results" + ], + "type": "object" + } + } + }, + "description": "A list of results." + }, + "400": { + "content": { + "application/json": { + "schema": { + "properties": { + "error": { + "description": "A message describing the source of the error.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "ERROR" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "error" + ], + "type": "object" + } + } + }, + "description": "An error message." + } + }, + "summary": "futures_contracts_v1 API", + "tags": [ + "default" + ] + } + }, + "/futures/vX/contracts/{ticker}": { + "get": { + "description": "The Contract Details endpoint returns the details for a single contract at a specific point in time.", + "operationId": "GetFuturesContractDetails", + "parameters": [ + { + "description": "The ticker symbol of the contract to retrieve.", + "example": "ESU0", + "in": "path", + "name": "ticker", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The point-in-time of the data to be retrieved. Note that the contract data returned for a given date represents the state of that contract on that day. A date in the format YYYY-MM-DD (default=today).", + "in": "query", + "name": "as_of", + "schema": { + "format": "date", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "request_id": "000a000a0a0a000a0a0aa00a0a0000a0", + "results": { + "active": true, + "as_of": "2025-07-07", + "days_to_maturity": 1901, + "first_trade_date": "2025-06-20", + "last_trade_date": "2030-09-20", + "max_order_quantity": 3000, + "min_order_quantity": 1, + "name": "ESU0 Future", + "product_code": "ES", + "settlement_tick_size": 0.25, + "spread_tick_size": 0.01, + "ticker": "ESU0", + "trade_tick_size": 0.25, + "trading_venue": "XCME", + "type": "single" + }, + "status": "OK" + }, + "schema": { + "properties": { + "request_id": { + "description": "A unique identifier for this request.", + "type": "string" + }, + "results": { + "properties": { + "active": { + "description": "Whether or not this contract was tradeable at the given point-in-time specified in the 'as_of' attribute (a contract was active if the given day was after the 'first_trade_date' and before the 'last_trade_date').", + "type": "boolean" + }, + "as_of": { + "description": "The point-in-time date for the given contract - e.g. if 'as_of' is set to 2021-04-25, then the data retrieved describes the contract(s) as of 2021-04-25.", + "format": "date", + "type": "string" + }, + "days_to_maturity": { + "description": "The number of days until this contract matures (since the point-in-time date). Note that the absence of this field means there are 0 days until maturity.", + "type": "integer" + }, + "first_trade_date": { + "description": "The date on which this contract first became tradeable.", + "format": "date", + "type": "string" + }, + "last_trade_date": { + "description": "The date on which this contract last became tradeable.", + "format": "date", + "type": "string" + }, + "maturity": { + "description": "This field provides the calendar month reflected in the instrument symbol. For futures spreads and options spreads, this field contains the first leg's calendar month reflected in the instrument symbol. For daily products, this tag contains the full calendar date (YYYYMMDD) as reflected in the instrument symbol.", + "type": "string" + }, + "max_order_quantity": { + "description": "The maximum order quantity for this contract.", + "type": "integer" + }, + "min_order_quantity": { + "description": "The minimum order quantity for this contract.", + "type": "integer" + }, + "name": { + "description": "The name of the contract.", + "type": "string" + }, + "product_code": { + "description": "The unique identifier for the product to which this contract belongs.", + "type": "string" + }, + "settlement_date": { + "description": "The final settlement date for the contract.", + "format": "date", + "type": "string" + }, + "settlement_tick_size": { + "description": "The settlement tick size for this contract.", + "type": "number" + }, + "spread_tick_size": { + "description": "The spread tick size for this contract.", + "type": "number" + }, + "ticker": { + "description": "The unique identifier for the contract, typically consisting of the product code and expiration date.", + "type": "string" + }, + "trade_tick_size": { + "description": "The tick size for this contract.", + "type": "number" + }, + "trading_venue": { + "description": "The trading venue (MIC) for the exchange on which this contract trades.", + "type": "string" + }, + "type": { + "description": "The type of contract, one of \"single\" or \"combo\".", + "type": "string" + } + }, + "required": [ + "ticker", + "product_code", + "first_trade_date", + "last_trade_date", + "trading_venue", + "active", + "type" + ], + "type": "object", + "x-polygon-go-type": { + "name": "Contract" + } + }, + "status": { + "description": "The status of this request's response.", + "type": "string" + } + }, + "required": [ + "status", + "request_id" + ], + "type": "object" + } + } + }, + "description": "A single contract as it was at the given point-in-time." + } + }, + "summary": "Contract Details", + "tags": [ + "default" + ], + "x-polygon-entitlement-data-type": { + "description": "Reference data", + "name": "reference" + } + } + }, + "/futures/vX/exchanges": { + "get": { + "description": "US futures exchanges and trading venues including major derivatives exchanges (CME, CBOT, NYMEX, COMEX) and other futures market infrastructure for commodity, financial, and other derivative contract trading.", + "operationId": "get_futures_vX_exchanges", + "parameters": [ + { + "description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '999'.", + "in": "query", + "name": "limit", + "schema": { + "default": 100, + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "count": 1, + "request_id": 1, + "results": [ + { + "acronym": "CME", + "id": "4", + "locale": "US", + "mic": "XCME", + "name": "Chicago Mercantile Exchange", + "operating_mic": "XCME", + "type": "exchange", + "url": "https://cmegroup.com" + } + ], + "status": "OK" + }, + "schema": { + "properties": { + "next_url": { + "description": "If present, this value can be used to fetch the next page.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "results": { + "description": "The results for this request.", + "items": { + "properties": { + "acronym": { + "description": "Well-known acronym for the exchange (e.g., 'CME', 'NYMEX', 'CBOT', 'COMEX').", + "type": "string" + }, + "id": { + "description": "Numeric identifier for the futures exchange or trading venue.", + "type": "string" + }, + "locale": { + "description": "Geographic location code where the exchange operates.", + "type": "string" + }, + "mic": { + "description": "Market Identifier Code (MIC) - ISO 10383 standard four-character code for the futures market.", + "type": "string" + }, + "name": { + "description": "Full official name of the futures exchange (e.g., 'Chicago Mercantile Exchange', 'New York Mercantile Exchange').", + "type": "string" + }, + "operating_mic": { + "description": "Operating Market Identifier Code for the futures exchange.", + "type": "string" + }, + "type": { + "description": "Type of venue - 'exchange' for futures exchanges and derivatives trading platforms.", + "type": "string" + }, + "url": { + "description": "Official website URL of the futures exchange organization.", + "type": "string" + } + }, + "required": [ + "id", + "type", + "name" + ], + "type": "object" + }, + "type": "array" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "OK" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "results" + ], + "type": "object" + } + } + }, + "description": "A list of results." + }, + "400": { + "content": { + "application/json": { + "schema": { + "properties": { + "error": { + "description": "A message describing the source of the error.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "ERROR" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "error" + ], + "type": "object" + } + } + }, + "description": "An error message." + } + }, + "tags": [ + "default" + ] + } + }, + "/futures/vX/market-status": { + "get": { + "description": "The market status endpoint returns the current status of the futures market for the given product code(s).", + "operationId": "GetFuturesMarketStatuses", + "parameters": [ + { + "description": "The product code(s) to return market statuses for.\n\nMultiple product codes can be specified by separating them with a comma. Currently, the limit is 250 product codes.", + "in": "query", + "name": "product_code.any_of", + "schema": { + "example": "ES,CL", + "type": "string" + } + }, + { + "description": "The product code to return market statuses for.", + "in": "query", + "name": "product_code", + "schema": { + "example": "ES", + "type": "string" + } + }, + { + "description": "The number of results to return per page (default=100, max=1000, min=1).", + "in": "query", + "name": "limit", + "schema": { + "default": 100, + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "Sort results by field and direction using dotted notation (e.g., 'ticker.asc', 'name.desc').", + "in": "query", + "name": "sort", + "schema": { + "default": "product_code.asc", + "enum": [ + "product_code.asc", + "product_code.desc" + ], + "example": "product_code.asc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "next_url": { + "description": "If present, this value can be used to fetch the next page of data.", + "example": "https://api.massive.com/futures/vX/products?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "type": "string" + }, + "request_id": { + "description": "A unique identifier for this request.", + "example": "ac0a1b0b-0b0b-4b0b-8b0b-0b0b0b0b0b0b", + "type": "string" + }, + "results": { + "items": { + "properties": { + "market_status": { + "description": "The current status of the market.", + "enum": [ + "pre_open", + "open", + "close", + "pause", + "post_close_pre_open" + ], + "example": "open", + "type": "string" + }, + "product_code": { + "description": "The product code for the product.", + "example": "ES", + "type": "string" + }, + "trading_venue": { + "description": "The trading venue (MIC) for the exchange on which the corresponding product trades.", + "example": "XNYM", + "type": "string" + } + }, + "required": [ + "market_status", + "product_code" + ], + "type": "object", + "x-polygon-go-type": { + "name": "MarketStatusesResult" + } + }, + "type": "array" + }, + "status": { + "description": "The status of this request's response.", + "example": "OK", + "type": "string" + }, + "timestamp": { + "description": "An RFC3339 timestamp representing the moment at which the market statuses were evaluated.", + "example": "2025-02-27T13:26:35.905149Z", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "timestamp" + ], + "type": "object" + } + } + }, + "description": "A list of statuses for each product and market identifier code." + } + }, + "summary": "Market Status", + "tags": [ + "default" + ], + "x-polygon-entitlement-data-type": { + "description": "Reference data", + "name": "reference" + } + } + }, + "/futures/vX/products": { + "get": { + "description": "The Products endpoint returns a list of futures products. This endpoint can be used to query for products based on a variety of parameters, including by the product's name, exchange, sector, sub-sector, asset class, asset sub-class, and type.", + "operationId": "GetFuturesProducts", + "parameters": [ + { + "description": "Search for products by Product Name. This parameter supports an exact match, while a name-contains search can be performed using the `name.search` parameter. Note that the search is case-sensitive.", + "in": "query", + "name": "name", + "schema": { + "type": "string" + }, + "x-polygon-filter-field": { + "search": true + } + }, + { + "description": "A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about products for the specified day (default=today).", + "in": "query", + "name": "as_of", + "schema": { + "format": "date", + "type": "string" + } + }, + { + "description": "The trading venue (MIC) for the exchange on which the products trades.", + "in": "query", + "name": "trading_venue", + "schema": { + "type": "string" + } + }, + { + "description": "The sector to which the products belong.", + "in": "query", + "name": "sector", + "schema": { + "enum": [ + "asia", + "base", + "biofuels", + "coal", + "cross_rates", + "crude_oil", + "custom_index", + "dairy", + "dj_ubs_ci", + "electricity", + "emissions", + "europe", + "fertilizer", + "forestry", + "grains_and_oilseeds", + "intl_index", + "liq_nat_gas_lng", + "livestock", + "long_term_gov", + "long_term_non_gov", + "majors", + "minors", + "nat_gas", + "nat_gas_liq_petro", + "precious", + "refined_products", + "s_and_p_gsci", + "sel_sector_index", + "short_term_gov", + "short_term_non_gov", + "softs", + "us", + "us_index", + "wet_bulk" + ], + "type": "string" + } + }, + { + "description": "The sub-sector to which the products belong.", + "in": "query", + "name": "sub_sector", + "schema": { + "enum": [ + "asian", + "canadian", + "cat", + "cooling_degree_days", + "ercot", + "european", + "gulf", + "heating_degree_days", + "iso_ne", + "large_cap_index", + "mid_cap_index", + "miso", + "north_american", + "nyiso", + "pjm", + "small_cap_index", + "west", + "western_power" + ], + "type": "string" + } + }, + { + "description": "The asset class to which the products belong.", + "in": "query", + "name": "asset_class", + "schema": { + "enum": [ + "alt_investment", + "commodity", + "financials" + ], + "type": "string" + } + }, + { + "description": "The asset sub-class to which the products belong.", + "in": "query", + "name": "asset_sub_class", + "schema": { + "enum": [ + "agricultural", + "commodity_index", + "energy", + "equity", + "foreign_exchange", + "freight", + "housing", + "interest_rate", + "metals", + "weather" + ], + "type": "string" + } + }, + { + "description": "The type of products to return. One of \"all\", \"single\", or \"combo\" (default=all).", + "in": "query", + "name": "type", + "schema": { + "default": "all", + "enum": [ + "all", + "single", + "combo" + ], + "type": "string" + } + }, + { + "description": "The number of results to return per page (default=100, maximum=1000, minimum=1).", + "in": "query", + "name": "limit", + "schema": { + "default": 100, + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "Search by name.", + "in": "query", + "name": "name.search", + "schema": { + "type": "string" + } + }, + { + "description": "Sort results by field and direction using dotted notation (e.g., 'ticker.asc', 'name.desc').", + "in": "query", + "name": "sort", + "schema": { + "default": "name.asc", + "enum": [ + "name.asc", + "name.desc", + "trading_venue.asc", + "trading_venue.desc", + "sector.asc", + "sector.desc", + "sub_sector.asc", + "sub_sector.desc", + "asset_class.asc", + "asset_class.desc", + "asset_sub_class.asc", + "asset_sub_class.desc", + "type.asc", + "type.desc" + ], + "example": "name.asc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "next_url": "https://api.massive.com/futures/vX/products?cursor=YXA9MTAwJmFzPSZhc19vZj0yMDI1LTA3LTA3JmxpbWl0PTEwMCZzb3J0PW5hbWUuYXNj", + "request_id": "000a000a0a0a000a0a0aa00a0a0000a0", + "results": [ + { + "asset_class": "commodity", + "asset_sub_class": "energy", + "clearing_channel": "exchange_only", + "date": "2025-07-07", + "last_updated": "2025-02-22", + "name": "1% Fuel Oil Barges FOB Rdam (Platts) vs. 1% Fuel Oil Cargoes FOB NWE (Platts) BALMO Futures", + "price_quotation": "U.S. dollars and cents per metric ton", + "product_code": "EBE", + "sector": "refined_products", + "settlement_currency_code": "USD", + "settlement_method": "financially_settled", + "settlement_type": "cash", + "sub_sector": "european", + "trade_currency_code": "USD", + "trading_venue": "XNYM", + "type": "single", + "unit_of_measure": "MTONS", + "unit_of_measure_quantity": 1000 + }, + { + "asset_class": "commodity", + "asset_sub_class": "energy", + "clearing_channel": "exchange_only", + "date": "2025-07-07", + "last_updated": "2025-06-25", + "name": "1% Fuel Oil Cargoes CIF MED (Platts) BALMO Futures", + "price_quotation": "U.S. dollars and cents per metric ton", + "product_code": "AOB", + "sector": "refined_products", + "settlement_currency_code": "USD", + "settlement_method": "financially_settled", + "settlement_type": "cash", + "sub_sector": "european", + "trade_currency_code": "USD", + "trading_venue": "XNYM", + "type": "single", + "unit_of_measure": "MTONS", + "unit_of_measure_quantity": 1000 + } + ], + "status": "OK" + }, + "schema": { + "properties": { + "next_url": { + "description": "If present, this value can be used to fetch the next page of data.", + "type": "string" + }, + "request_id": { + "description": "A unique identifier for this request.", + "type": "string" + }, + "results": { + "items": { + "properties": { + "as_of": { + "description": "The point-in-time date for the given product - e.g. if 'as_of' is set to 2024-11-05, then these were the details for this product on that day.", + "format": "date", + "type": "string" + }, + "asset_class": { + "description": "The asset class to which the product belongs.", + "type": "string" + }, + "asset_sub_class": { + "description": "The asset sub-class to which the product belongs.", + "type": "string" + }, + "clearing_channel": { + "description": "The clearing channel for this product. Indicates whether the product can be cleared only through exchanges or through both exchanges and over-the-counter.", + "enum": [ + "exchange_only", + "exchange_and_otc" + ], + "type": "string" + }, + "last_updated": { + "description": "The date and time at which this product was last updated.", + "format": "date-time", + "type": "string" + }, + "name": { + "description": "The full name of the product.", + "type": "string" + }, + "price_quotation": { + "description": "The quoted price for this product.", + "type": "string" + }, + "product_code": { + "description": "The unique identifier for the product.", + "type": "string" + }, + "sector": { + "description": "The sector to which the product belongs.", + "type": "string" + }, + "settlement_currency_code": { + "description": "The currency in which this product settles.", + "type": "string" + }, + "settlement_method": { + "description": "The method of settlement for this product (Financially Settled or Deliverable).", + "type": "string" + }, + "settlement_type": { + "description": "The type of settlement for this product.", + "type": "string" + }, + "sub_sector": { + "description": "The sub-sector to which the product belongs.", + "type": "string" + }, + "trade_currency_code": { + "description": "The currency in which this product trades.", + "type": "string" + }, + "trading_venue": { + "description": "The trading venue (MIC) for the exchange on which this contract trades.", + "type": "string" + }, + "type": { + "description": "The type of product, one of \"single\" or \"combo\".", + "type": "string" + }, + "unit_of_measure": { + "description": "The unit of measure for this product.", + "type": "string" + }, + "unit_of_measure_quantity": { + "description": "The quantity of the unit of measure for this product.", + "type": "number" + } + }, + "required": [ + "product_code" + ], + "type": "object", + "x-polygon-go-type": { + "name": "Product" + } + }, + "type": "array" + }, + "status": { + "description": "The status of this request's response.", + "example": "OK", + "type": "string" + } + }, + "required": [ + "status", + "request_id" + ], + "type": "object" + } + } + }, + "description": "A list of products which match all of the query parameters." + } + }, + "summary": "Products", + "tags": [ + "default" + ], + "x-polygon-entitlement-data-type": { + "description": "Reference data", + "name": "reference" + } + } + }, + "/futures/vX/products-new": { + "get": { + "description": "Retrieve detailed information about a single futures product as of a specified date, including its asset class, exchange code, full product name, settlement details, pricing quotation, sector classifications, and unit of measure. Optional parameters such as product type (single or combo) and as_of allow you to capture the product’s state on a specific day, providing essential context for trading decisions and system integrations.\n\nUse Cases: Product specification, historical product checks, risk management, trading system integration.", + "operationId": "get_futures_vX_products-new", + "parameters": [ + { + "description": "The full name of the product.", + "in": "query", + "name": "name", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "name.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "name.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "name.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "name.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "name.lte", + "schema": { + "type": "string" + } + }, + { + "description": "The unique identifier for the product.", + "in": "query", + "name": "product_code", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "product_code.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "product_code.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "product_code.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "product_code.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "product_code.lte", + "schema": { + "type": "string" + } + }, + { + "description": "A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about products for the specified day (default=today). Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "date", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "date.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "date.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "date.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "date.lte", + "schema": { + "type": "string" + } + }, + { + "description": "The sector to which the product belongs.", + "in": "query", + "name": "sector", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "sector.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "sector.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "sector.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "sector.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "sector.lte", + "schema": { + "type": "string" + } + }, + { + "description": "The sub-sector to which the product belongs.", + "in": "query", + "name": "sub_sector", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "sub_sector.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "sub_sector.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "sub_sector.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "sub_sector.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "sub_sector.lte", + "schema": { + "type": "string" + } + }, + { + "description": "The asset class to which the product belongs.", + "in": "query", + "name": "asset_class", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "asset_class.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "asset_class.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "asset_class.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "asset_class.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "asset_class.lte", + "schema": { + "type": "string" + } + }, + { + "description": "The asset sub-class to which the product belongs.", + "in": "query", + "name": "asset_sub_class", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "asset_sub_class.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "asset_sub_class.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "asset_sub_class.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "asset_sub_class.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "asset_sub_class.lte", + "schema": { + "type": "string" + } + }, + { + "description": "The type of product, one of 'single' or 'combo'.", + "in": "query", + "name": "type", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "type.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "type.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "type.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "type.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "type.lte", + "schema": { + "type": "string" + } + }, + { + "description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.", + "in": "query", + "name": "limit", + "schema": { + "default": 100, + "maximum": 50001, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'asc' if not specified.", + "in": "query", + "name": "sort", + "schema": { + "default": "date.asc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "next_url": { + "description": "If present, this value can be used to fetch the next page.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "results": { + "description": "The results for this request.", + "items": { + "properties": { + "asset_class": { + "description": "The asset class to which the product belongs.", + "type": "string" + }, + "asset_sub_class": { + "description": "The asset sub-class to which the product belongs.", + "type": "string" + }, + "date": { + "description": "A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about products for the specified day (default=today).", + "format": "date", + "type": "string" + }, + "display_factor": { + "format": "int64", + "type": "integer" + }, + "group_code": { + "type": "string" + }, + "last_updated": { + "format": "int64", + "type": "integer" + }, + "latest": { + "type": "boolean" + }, + "name": { + "description": "The full name of the product.", + "type": "string" + }, + "price_quotation": { + "description": "The quoted price for this product.", + "type": "string" + }, + "product_code": { + "description": "The unique identifier for the product.", + "type": "string" + }, + "sector": { + "description": "The sector to which the product belongs.", + "type": "string" + }, + "settlement_currency_code": { + "description": "The currency in which this product settles.", + "type": "string" + }, + "settlement_method": { + "description": "The method of settlement for this product (Financially Settled or Deliverable).", + "type": "string" + }, + "settlement_type": { + "description": "The type of settlement for this product.", + "type": "string" + }, + "sub_sector": { + "description": "The sub-sector to which the product belongs.", + "type": "string" + }, + "trade_currency_code": { + "description": "The currency in which this product trades.", + "type": "string" + }, + "trading_venue": { + "description": "The trading venue (MIC) for the exchange on which this contract trades.", + "type": "string" + }, + "type": { + "description": "The type of product, one of 'single' or 'combo'.", + "type": "string" + }, + "unit_of_measure": { + "description": "The unit of measure for this product.", + "type": "string" + }, + "unit_of_measure_qty": { + "description": "The quantity of the unit of measure for this product.", + "format": "double", + "type": "number" + } + }, + "required": [ + "date" + ], + "type": "object" + }, + "type": "array" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "OK" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "results" + ], + "type": "object" + } + } + }, + "description": "A list of results." + }, + "400": { + "content": { + "application/json": { + "schema": { + "properties": { + "error": { + "description": "A message describing the source of the error.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "ERROR" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "error" + ], + "type": "object" + } + } + }, + "description": "An error message." + } + }, + "summary": "futures_products_v1 API", + "tags": [ + "default" + ] + } + }, + "/futures/vX/products/{product_code}": { + "get": { + "description": "The Product Details endpoint returns the details for a single product as of a specific day.", + "operationId": "GetFuturesProductDetails", + "parameters": [ + { + "description": "The unique identifier for a product.", + "example": "ES", + "in": "path", + "name": "product_code", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The type of product to return. One of \"single\" or \"combo\" (default=single).", + "in": "query", + "name": "type", + "schema": { + "default": "single", + "enum": [ + "single", + "combo" + ], + "type": "string" + } + }, + { + "description": "A date string in the format YYYY-MM-DD. Note that the data returned is the state of this product's data at that point-in-time.", + "in": "query", + "name": "as_of", + "schema": { + "format": "date", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "request_id": "000a000a0a0a000a0a0aa00a0a0000a0", + "results": { + "asset_class": "financials", + "asset_sub_class": "equity", + "clearing_channel": "exchange_only", + "date": "2025-07-07", + "last_updated": "2025-07-04", + "name": "E-mini S&P 500 Futures", + "price_quotation": "U.S. dollars and cents per index point", + "product_code": "ES", + "sector": "us_index", + "settlement_currency_code": "USD", + "settlement_method": "financially_settled", + "settlement_type": "cash", + "sub_sector": "small_cap_index", + "trade_currency_code": "USD", + "trading_venue": "XCME", + "type": "single", + "unit_of_measure": "IPNT", + "unit_of_measure_quantity": 50 + }, + "status": "OK" + }, + "schema": { + "properties": { + "request_id": { + "description": "A unique identifier for this request.", + "type": "string" + }, + "results": { + "properties": { + "as_of": { + "description": "The point-in-time date for the given product - e.g. if 'as_of' is set to 2024-11-05, then these were the details for this product on that day.", + "format": "date", + "type": "string" + }, + "asset_class": { + "description": "The asset class to which the product belongs.", + "type": "string" + }, + "asset_sub_class": { + "description": "The asset sub-class to which the product belongs.", + "type": "string" + }, + "clearing_channel": { + "description": "The clearing channel for this product. Indicates whether the product can be cleared only through exchanges or through both exchanges and over-the-counter.", + "enum": [ + "exchange_only", + "exchange_and_otc" + ], + "type": "string" + }, + "last_updated": { + "description": "The date and time at which this product was last updated.", + "format": "date-time", + "type": "string" + }, + "name": { + "description": "The full name of the product.", + "type": "string" + }, + "price_quotation": { + "description": "The quoted price for this product.", + "type": "string" + }, + "product_code": { + "description": "The unique identifier for the product.", + "type": "string" + }, + "sector": { + "description": "The sector to which the product belongs.", + "type": "string" + }, + "settlement_currency_code": { + "description": "The currency in which this product settles.", + "type": "string" + }, + "settlement_method": { + "description": "The method of settlement for this product (Financially Settled or Deliverable).", + "type": "string" + }, + "settlement_type": { + "description": "The type of settlement for this product.", + "type": "string" + }, + "sub_sector": { + "description": "The sub-sector to which the product belongs.", + "type": "string" + }, + "trade_currency_code": { + "description": "The currency in which this product trades.", + "type": "string" + }, + "trading_venue": { + "description": "The trading venue (MIC) for the exchange on which this contract trades.", + "type": "string" + }, + "type": { + "description": "The type of product, one of \"single\" or \"combo\".", + "type": "string" + }, + "unit_of_measure": { + "description": "The unit of measure for this product.", + "type": "string" + }, + "unit_of_measure_quantity": { + "description": "The quantity of the unit of measure for this product.", + "type": "number" + } + }, + "required": [ + "product_code" + ], + "type": "object", + "x-polygon-go-type": { + "name": "Product" + } + }, + "status": { + "description": "The status of this request's response.", + "type": "string" + } + }, + "required": [ + "status", + "request_id" + ], + "type": "object" + } + } + }, + "description": "A single Product as it was at the given point-in-time." + } + }, + "summary": "Product Details", + "tags": [ + "default" + ], + "x-polygon-entitlement-data-type": { + "description": "Reference data", + "name": "reference" + } + } + }, + "/futures/vX/products/{product_code}/schedules": { + "get": { + "description": "The Product-Specific Futures Schedules API provides detailed trading schedules for a specific futures product. This API allows you to query schedules for a single product across a range of dates. Users can access comprehensive information about trading sessions, including market events such as preopen, open, and closed, along with their precise timestamps.", + "operationId": "GetFuturesProductSchedules", + "parameters": [ + { + "description": "The product code for the futures product.", + "example": "ES", + "in": "path", + "name": "product_code", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The date on which the schedule's trading day ended (sometimes referred to as trading date). Defaults to today. Formatted as `YYYY-MM-DD`. Note that although there is no time component the day is assumed to be that day in Central Time.", + "in": "query", + "name": "session_end_date", + "schema": { + "format": "date", + "type": "string" + }, + "x-polygon-filter-field": { + "range": true + } + }, + { + "description": "The number of results to return per page (default=100, max=1000, min=1).", + "in": "query", + "name": "limit", + "schema": { + "default": 100, + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "Range by session_end_date.", + "in": "query", + "name": "session_end_date.gte", + "schema": { + "format": "date", + "type": "string" + } + }, + { + "description": "Range by session_end_date.", + "in": "query", + "name": "session_end_date.gt", + "schema": { + "format": "date", + "type": "string" + } + }, + { + "description": "Range by session_end_date.", + "in": "query", + "name": "session_end_date.lte", + "schema": { + "format": "date", + "type": "string" + } + }, + { + "description": "Range by session_end_date.", + "in": "query", + "name": "session_end_date.lt", + "schema": { + "format": "date", + "type": "string" + } + }, + { + "description": "Sort results by field and direction using dotted notation (e.g., 'ticker.asc', 'name.desc').", + "in": "query", + "name": "sort", + "schema": { + "default": "session_end_date.desc", + "enum": [ + "session_end_date.asc", + "session_end_date.desc" + ], + "example": "session_end_date.desc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "next_url": "https://api.massive.com/futures/vX/products/ES/schedules?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "request_id": "000a000a0a0a000a0a0aa00a0a0000a0", + "results": [ + { + "example": "E-Mini S&P 500 Futures", + "product_code": "ES", + "product_name": "E-Mini S&P 500 Futures", + "schedule": [ + { + "event": "pre_open", + "timestamp": "2025-11-24T18:45:00:00-06:00" + }, + { + "event": "open", + "timestamp": "2025-11-24T19:00:00-06:00" + }, + { + "event": "close", + "timestamp": "2025-11-25T18:00:00-06:00" + } + ], + "session_end_date": "2025-11-24", + "trading_venue": "XNYM" + }, + { + "product_code": "ES", + "product_name": "E-Mini S&P 500 Futures", + "schedule": [ + { + "event": "pre_open", + "timestamp": "2025-11-24T18:45:00:00-06:00" + }, + { + "event": "open", + "timestamp": "2025-11-24T19:00:00-06:00" + }, + { + "event": "close", + "timestamp": "2025-11-25T18:00:00-06:00" + } + ], + "session_end_date": "2025-11-21", + "trading_venue": "XNYM" + } + ], + "status": "OK" + }, + "schema": { + "properties": { + "error": { + "description": "An optional error message for failed requests when available.", + "type": "string" + }, + "next_url": { + "description": "If present, this value can be used to fetch the next page of data.", + "type": "string" + }, + "request_id": { + "description": "The unique identifier for the request.", + "type": "string" + }, + "results": { + "description": "The list of schedules for the specified product.", + "items": { + "properties": { + "product_code": { + "description": "The product code for the futures product to which this schedule applies.", + "type": "string" + }, + "product_name": { + "description": "The name of the futures product to which this schedule applies.", + "type": "string" + }, + "schedule": { + "items": { + "properties": { + "event": { + "description": "The market event for this schedule.", + "enum": [ + "pre_open", + "open", + "close", + "pause", + "post_close_pre_open" + ], + "type": "string" + }, + "timestamp": { + "description": "The timestamp for this market event in Central Time.", + "format": "time", + "type": "string" + } + }, + "required": [ + "event", + "timestamp" + ], + "type": "object" + }, + "type": "array" + }, + "session_end_date": { + "description": "The date on which the schedule's trading day ended (sometimes referred to as trading date) formatted as `YYYY-MM-DD`. Note that although there is no time component on this attribute, the day refers to Central Time.", + "format": "date", + "type": "string" + }, + "trading_venue": { + "description": "The trading venue (MIC) for the exchange on which this schedule's product trades.", + "type": "string" + } + }, + "required": [ + "session_end_date", + "product_code", + "schedule" + ], + "type": "object", + "x-polygon-go-type": { + "name": "SchedulesResult" + } + }, + "type": "array" + }, + "status": { + "description": "The status of the response.", + "type": "string" + } + }, + "required": [ + "status", + "request_id" + ], + "type": "object" + } + } + }, + "description": "A list of schedules for each product." + } + }, + "summary": "Product Schedules", + "tags": [ + "default" + ], + "x-polygon-entitlement-data-type": { + "description": "Reference data", + "name": "reference" + } + } + }, + "/futures/vX/quotes/{ticker}": { + "get": { + "description": "Get quotes for a contract in a given time range.", + "operationId": "GetFuturesQuotes", + "parameters": [ + { + "description": "The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract).", + "example": "GCJ5", + "in": "path", + "name": "ticker", + "required": true, + "schema": { + "type": "string" + }, + "x-polygon-go-id": "Ticker" + }, + { + "description": "Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp.", + "in": "query", + "name": "timestamp", + "schema": { + "type": "string" + }, + "x-polygon-filter-field": { + "range": true + } + }, + { + "description": "Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format.", + "in": "query", + "name": "session_end_date", + "schema": { + "type": "string" + }, + "x-polygon-filter-field": { + "range": true + } + }, + { + "description": "The number of results to return per page (default=1000, maximum=50000, minimum=1).", + "in": "query", + "name": "limit", + "schema": { + "default": 1000, + "maximum": 50000, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "Range by timestamp.", + "in": "query", + "name": "timestamp.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Range by timestamp.", + "in": "query", + "name": "timestamp.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Range by timestamp.", + "in": "query", + "name": "timestamp.lte", + "schema": { + "type": "string" + } + }, + { + "description": "Range by timestamp.", + "in": "query", + "name": "timestamp.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Range by session_end_date.", + "in": "query", + "name": "session_end_date.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Range by session_end_date.", + "in": "query", + "name": "session_end_date.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Range by session_end_date.", + "in": "query", + "name": "session_end_date.lte", + "schema": { + "type": "string" + } + }, + { + "description": "Range by session_end_date.", + "in": "query", + "name": "session_end_date.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Sort results by field and direction using dotted notation (e.g., 'ticker.asc', 'name.desc').", + "in": "query", + "name": "sort", + "schema": { + "default": "timestamp.desc", + "enum": [ + "timestamp.asc", + "timestamp.desc" + ], + "example": "timestamp.desc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3", + "results": [ + { + "ask_price": 604075, + "ask_size": 6, + "ask_timestamp": 1734467086235923000, + "bid_price": 604075, + "bid_size": 6, + "bid_timestamp": 1734415473057885400, + "session_end_date": "2024-12-17", + "ticker": "ESZ4", + "timestamp": 1734476400002853000 + }, + { + "ask_price": 604100, + "ask_size": 2, + "ask_timestamp": 1734466901129138400, + "bid_price": 604100, + "bid_size": 2, + "bid_timestamp": 1734415473057885400, + "session_end_date": "2024-12-17", + "ticker": "ESZ4", + "timestamp": 1734466901128680000 + } + ], + "status": "OK" + }, + "schema": { + "properties": { + "next_url": { + "description": "If present, this value can be used to fetch the next page of data.", + "type": "string" + }, + "results": { + "items": { + "properties": { + "ask_price": { + "description": "The ask price is expressed per unit of the underlying asset, and you apply the contract multiplier to get the full contract value.", + "format": "double", + "type": "number" + }, + "ask_size": { + "description": "The quote size represents the number of futures contracts available at the given ask price.", + "format": "double", + "type": "number" + }, + "ask_timestamp": { + "description": "The time when the ask price was submitted to the exchange.", + "type": "integer", + "x-polygon-go-type": { + "name": "IMilliseconds", + "path": "github.com/polygon-io/ptime" + } + }, + "bid_price": { + "description": "The bid price is expressed per unit of the underlying asset, and you apply the contract multiplier to get the full contract value.", + "format": "double", + "type": "number" + }, + "bid_size": { + "description": "The quote size represents the number of futures contracts available at the given bid price.", + "format": "double", + "type": "number" + }, + "bid_timestamp": { + "description": "The time when the bid price was submitted to the exchange.", + "type": "integer", + "x-polygon-go-type": { + "name": "IMilliseconds", + "path": "github.com/polygon-io/ptime" + } + }, + "session_end_date": { + "description": "Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format.", + "type": "string" + }, + "ticker": { + "description": "The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract).", + "type": "string" + }, + "timestamp": { + "description": "The time when the quote was generated at the exchange to nanosecond precision.", + "type": "integer", + "x-polygon-go-type": { + "name": "IMilliseconds", + "path": "github.com/polygon-io/ptime" + } + } + }, + "required": [ + "ticker", + "timestamp", + "session_end_date" + ], + "type": "object", + "x-polygon-go-type": { + "name": "Futures" + } + }, + "type": "array" + }, + "status": { + "description": "The status of this request's response.", + "type": "string" + } + }, + "required": [ + "status" + ], + "type": "object" + } + } + }, + "description": "A list of quotes." + } + }, + "summary": "Quotes", + "tags": [ + "default" + ], + "x-polygon-entitlement-data-type": { + "description": "Futures quotes data", + "name": "nbbo" + }, + "x-polygon-entitlement-market-type": { + "description": "Futures data", + "name": "futures" + }, + "x-polygon-replaces": { + "date": 1654056060000, + "replaces": { + "name": "Quotes", + "path": "get_v1_us_futures_quotes__ticker___date" + } + } + } + }, + "/futures/vX/schedules": { + "get": { + "description": "The Trading-Date Based Futures Schedules API provides detailed trading schedules for all products on a specific day. This API allows you to retrieve detailed information about trading sessions, including market events like preopen, open, and closed, along with their precise timestamps.", + "operationId": "GetFuturesDailySchedules", + "parameters": [ + { + "description": "The session end date for the schedules (also known as the trading date). This is the day in CT for which the user wants to retrieve data. If left blank, this value defaults to 'today' in Central Time. e.g. If a request is made from Pacific Time on '2025-01-01' at 11:00 pm with no 'session_end_date' a default value of `2025-01-02` will be used.", + "in": "query", + "name": "session_end_date", + "schema": { + "format": "date", + "type": "string" + } + }, + { + "description": "The trading venue (MIC) of the exchange for the schedules.", + "in": "query", + "name": "trading_venue", + "schema": { + "type": "string" + } + }, + { + "description": "The number of results to return per page (default=100, max=1000, min=1).", + "in": "query", + "name": "limit", + "schema": { + "default": 100, + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "Sort results by field and direction using dotted notation (e.g., 'ticker.asc', 'name.desc').", + "in": "query", + "name": "sort", + "schema": { + "default": "trading_venue.asc", + "enum": [ + "trading_venue.asc", + "trading_venue.desc" + ], + "example": "trading_venue.asc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "next_url": "http://api.massive.com/futures/vX/schedules?cursor=YXA9MUUmYXM9WE5ZTSZsaW1pdD0yJm9yZGVyPWFzYyZzb3J0PXByb2R1Y3RfY29kZSZ0cmFkaW5nX2RhdGU9MjAyNC0xMS0yNQ", + "request_id": "000a000a0a0a000a0a0aa00a0a0000a0", + "results": [ + { + "product_code": "10Y", + "product_name": "10-YEAR YIELD CAL SPD", + "schedule": [ + { + "event": "pre_open", + "timestamp": "2025-07-06T16:00:00-05:00" + }, + { + "event": "open", + "timestamp": "2025-07-06T17:00:00-05:00" + }, + { + "event": "close", + "timestamp": "2025-07-07T16:00:00-05:00" + } + ], + "session_end_date": "2025-07-07", + "trading_venue": "XCBT" + }, + { + "product_code": "10Y", + "product_name": "10-Year Yield Futures", + "schedule": [ + { + "event": "pre_open", + "timestamp": "2025-07-06T16:00:00-05:00" + }, + { + "event": "open", + "timestamp": "2025-07-06T17:00:00-05:00" + }, + { + "event": "close", + "timestamp": "2025-07-07T16:00:00-05:00" + } + ], + "session_end_date": "2025-07-07", + "trading_venue": "XCBT" + } + ], + "status": "OK" + }, + "schema": { + "properties": { + "next_url": { + "description": "The URL for the next page of results.", + "type": "string" + }, + "request_id": { + "description": "The unique identifier for this request.", + "type": "string" + }, + "results": { + "description": "A list of schedules for each product.", + "items": { + "properties": { + "product_code": { + "description": "The product code for the futures product to which this schedule applies.", + "type": "string" + }, + "product_name": { + "description": "The name of the futures product to which this schedule applies.", + "type": "string" + }, + "schedule": { + "items": { + "properties": { + "event": { + "description": "The market event for this schedule.", + "enum": [ + "pre_open", + "open", + "close", + "pause", + "post_close_pre_open" + ], + "type": "string" + }, + "timestamp": { + "description": "The timestamp for this market event in Central Time.", + "format": "time", + "type": "string" + } + }, + "required": [ + "event", + "timestamp" + ], + "type": "object" + }, + "type": "array" + }, + "session_end_date": { + "description": "The date on which the schedule's trading day ended (sometimes referred to as trading date) formatted as `YYYY-MM-DD`. Note that although there is no time component on this attribute, the day refers to Central Time.", + "format": "date", + "type": "string" + }, + "trading_venue": { + "description": "The trading venue (MIC) for the exchange on which this schedule's product trades.", + "type": "string" + } + }, + "required": [ + "session_end_date", + "product_code", + "schedule" + ], + "type": "object", + "x-polygon-go-type": { + "name": "SchedulesResult" + } + }, + "type": "array" + }, + "status": { + "description": "The status of the response.", + "type": "string" + } + }, + "required": [ + "status", + "request_id" + ], + "type": "object" + } + } + }, + "description": "A list of schedules for a given day." + } + }, + "summary": "Daily Schedules", + "tags": [ + "default" + ], + "x-polygon-entitlement-data-type": { + "description": "Reference data", + "name": "reference" + } + } + }, + "/futures/vX/snapshot": { + "get": { + "description": "Retrieve a snapshot of the most recent futures contract data.", + "operationId": "get_futures_vX_snapshot", + "parameters": [ + { + "description": "The code for the contracts' underlying product.", + "in": "query", + "name": "product_code", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "product_code.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "product_code.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "product_code.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "product_code.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "product_code.lte", + "schema": { + "type": "string" + } + }, + { + "description": "The futures contract identifier, including the base symbol and contract expiration (e.g., ESZ24 for the December 2024 S&P 500 E-mini contract).", + "in": "query", + "name": "ticker", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "ticker.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "ticker.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "ticker.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "ticker.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "ticker.lte", + "schema": { + "type": "string" + } + }, + { + "description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.", + "in": "query", + "name": "limit", + "schema": { + "default": 100, + "maximum": 50001, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'ticker' if not specified. The sort order defaults to 'asc' if not specified.", + "in": "query", + "name": "sort", + "schema": { + "default": "ticker.asc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "count": 1, + "next_url": "https://api.massive.com/v1/futures/vX/snapshot?cursor=AQANAkNCBVNQ", + "request_id": "c4d50f4801874e30b63e674b844cf51f", + "results": [ + { + "details": { + "open_interest": 112, + "settlement_date": 1753851600000000000 + }, + "last_minute": { + "close": 240.00000000000003, + "high": 240.00000000000003, + "last_updated": 1746045300000, + "low": 240.00000000000003, + "open": 240.00000000000003, + "volume": 5 + }, + "last_quote": { + "ask": 240.50000000000003, + "ask_size": 3, + "ask_timestamp": 1746036204386194000, + "bid": 239.50000000000003, + "bid_size": 2, + "bid_timestamp": 1746035747932118000, + "last_updated": 1746046798024234200 + }, + "last_trade": { + "last_updated": 1746045242858242600, + "price": 240.00000000000003, + "size": 5 + }, + "product_code": "CB", + "session": { + "change": 21.11, + "change_percent": 0.09622134, + "close": 240.00000000000003, + "high": 241.00000000000003, + "low": 240.00000000000003, + "open": 240.00000000000003, + "previous_settlement": 219.39, + "settlement_price": 240.50000000000003, + "volume": 55 + }, + "ticker": "CBN5" + } + ], + "status": "OK" + }, + "schema": { + "properties": { + "next_url": { + "description": "If present, this value can be used to fetch the next page.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "results": { + "description": "The results for this request.", + "items": { + "properties": { + "details": { + "properties": { + "product_code": { + "type": "string" + }, + "settlement_date": { + "description": "The day that this contract is settled.", + "format": "int64", + "type": "integer" + }, + "ticker": { + "type": "string" + } + }, + "type": "object" + }, + "last_minute": { + "properties": { + "close": { + "description": "The price at the end of the minute bar.", + "format": "double", + "type": "number" + }, + "high": { + "description": "The highest price reached in the minute bar.", + "format": "double", + "type": "number" + }, + "last_updated": { + "description": "The timestamp indicating the most recent update to the minute bar.", + "format": "int64", + "type": "integer" + }, + "low": { + "description": "The lowest price reached in the minute bar.", + "format": "double", + "type": "number" + }, + "open": { + "description": "The opening price at the start of the minute bar.", + "format": "double", + "type": "number" + }, + "timeframe": { + "type": "string" + }, + "volume": { + "description": "The number of contracts traded in the minute bar.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "last_quote": { + "properties": { + "ask": { + "description": "The lowest price a seller is willing to accept.", + "format": "double", + "type": "number" + }, + "ask_size": { + "description": "The number of contracts available at the ask price.", + "format": "int32", + "type": "integer" + }, + "ask_timestamp": { + "description": "The time when the best ask price was last updated.", + "format": "int64", + "type": "integer" + }, + "bid": { + "description": "The highest price a buyer is willing to pay.", + "format": "double", + "type": "number" + }, + "bid_size": { + "description": "The number of contracts available at the bid price.", + "format": "int32", + "type": "integer" + }, + "bid_timestamp": { + "description": "The time when the best bid price was last updated.", + "format": "int64", + "type": "integer" + }, + "last_updated": { + "description": "The time when the quote was generated at the exchange to nanosecond precision.", + "format": "int64", + "type": "integer" + }, + "timeframe": { + "type": "string" + } + }, + "type": "object" + }, + "last_trade": { + "properties": { + "last_updated": { + "description": "The time when the trade was generated at the exchange to nanosecond precision.", + "format": "int64", + "type": "integer" + }, + "price": { + "description": "The price of the trade. This is the actual dollar value per whole contract of this trade. A trade of 100 contracts with a price of $2.00 would be worth a total dollar value of $200.00.", + "format": "double", + "type": "number" + }, + "size": { + "description": "The total number of contracts exchanged between buyers and sellers on a given trade.", + "format": "int64", + "type": "integer" + }, + "timeframe": { + "type": "string" + } + }, + "type": "object" + }, + "session": { + "properties": { + "change": { + "description": "The change in price during this session.", + "format": "double", + "type": "number" + }, + "change_percent": { + "description": "The percentage change in price during this session.", + "format": "double", + "type": "number" + }, + "close": { + "description": "The price at the end of the session.", + "format": "double", + "type": "number" + }, + "high": { + "description": "The highest price reached in the session.", + "format": "double", + "type": "number" + }, + "low": { + "description": "The lowest price reached in the session.", + "format": "double", + "type": "number" + }, + "open": { + "description": "The opening price at the start of the session.", + "format": "double", + "type": "number" + }, + "previous_settlement": { + "description": "The settlement price of the previous session.", + "format": "double", + "type": "number" + }, + "settlement_price": { + "description": "The final settlement price at the end of the session.", + "format": "double", + "type": "number" + }, + "volume": { + "description": "The number of contracts traded in the session.", + "format": "double", + "type": "number" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "array" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "OK" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "results" + ], + "type": "object" + } + } + }, + "description": "A list of results." + }, + "400": { + "content": { + "application/json": { + "schema": { + "properties": { + "error": { + "description": "A message describing the source of the error.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "ERROR" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "error" + ], + "type": "object" + } + } + }, + "description": "An error message." + } + }, + "summary": "futures_snapshot_v1 API", + "tags": [ + "default" + ] + } + }, + "/futures/vX/trades/{ticker}": { + "get": { + "description": "Get trades for a contract in a given time range.", + "operationId": "GetFuturesTrades", + "parameters": [ + { + "description": "The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract).", + "example": "GCJ5", + "in": "path", + "name": "ticker", + "required": true, + "schema": { + "type": "string" + }, + "x-polygon-go-id": "Ticker" + }, + { + "description": "Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp.", + "in": "query", + "name": "timestamp", + "schema": { + "type": "string" + }, + "x-polygon-filter-field": { + "range": true + } + }, + { + "description": "Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format.", + "in": "query", + "name": "session_end_date", + "schema": { + "type": "string" + }, + "x-polygon-filter-field": { + "range": true + } + }, + { + "description": "The number of results to return per page (default=1000, maximum=50000, minimum=1).", + "in": "query", + "name": "limit", + "schema": { + "default": 1000, + "maximum": 50000, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "Range by timestamp.", + "in": "query", + "name": "timestamp.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Range by timestamp.", + "in": "query", + "name": "timestamp.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Range by timestamp.", + "in": "query", + "name": "timestamp.lte", + "schema": { + "type": "string" + } + }, + { + "description": "Range by timestamp.", + "in": "query", + "name": "timestamp.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Range by session_end_date.", + "in": "query", + "name": "session_end_date.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Range by session_end_date.", + "in": "query", + "name": "session_end_date.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Range by session_end_date.", + "in": "query", + "name": "session_end_date.lte", + "schema": { + "type": "string" + } + }, + { + "description": "Range by session_end_date.", + "in": "query", + "name": "session_end_date.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Sort results by field and direction using dotted notation (e.g., 'ticker.asc', 'name.desc').", + "in": "query", + "name": "sort", + "schema": { + "default": "timestamp.desc", + "enum": [ + "timestamp.asc", + "timestamp.desc" + ], + "example": "timestamp.desc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3", + "results": [ + { + "price": 605400, + "session_end_date": "2024-12-17", + "size": 12, + "ticker": "ESZ4", + "timestamp": 1734484219379895800 + }, + { + "price": 605412, + "session_end_date": "2024-12-17", + "size": 55, + "ticker": "ESZ4", + "timestamp": 1734484212100118500 + }, + { + "price": 605544, + "session_end_date": "2024-12-17", + "size": 36, + "ticker": "ESZ4", + "timestamp": 1734484212099944200 + } + ], + "status": "OK" + }, + "schema": { + "properties": { + "next_url": { + "description": "If present, this value can be used to fetch the next page of data.", + "type": "string" + }, + "results": { + "items": { + "properties": { + "price": { + "description": "The price of the trade. This is the actual dollar value per whole contract of this trade. A trade of 100 contracts with a price of $2.00 would be worth a total dollar value of $200.00.", + "format": "double", + "type": "number" + }, + "session_end_date": { + "description": "Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format.", + "type": "string" + }, + "size": { + "description": "The total number of contracts exchanged between buyers and sellers on a given trade.", + "format": "double", + "type": "number" + }, + "ticker": { + "description": "ticker of the trade", + "type": "string" + }, + "timestamp": { + "description": "The time when the trade was generated at the exchange to nanosecond precision.", + "type": "integer", + "x-polygon-go-type": { + "name": "IMilliseconds", + "path": "github.com/polygon-io/ptime" + } + } + }, + "required": [ + "ticker", + "timestamp", + "session_end_date", + "price", + "size" + ], + "type": "object", + "x-polygon-go-type": { + "name": "Futures" + } + }, + "type": "array" + }, + "status": { + "description": "The status of this request's response.", + "type": "string" + } + }, + "required": [ + "status" + ], + "type": "object" + } + } + }, + "description": "A list of trades." + } + }, + "summary": "Trades", + "tags": [ + "default" + ], + "x-polygon-entitlement-data-type": { + "description": "Futures trade data", + "name": "trades" + }, + "x-polygon-entitlement-market-type": { + "description": "Futures data", + "name": "futures" + }, + "x-polygon-replaces": { + "date": 1654056060000, + "replaces": { + "name": "Trades", + "path": "get_v1_us_futures_trades__ticker___date" + } + } + } + }, + "/options/v1/exchanges": { + "get": { + "description": "US options exchanges and trading venues including traditional options exchanges (CBOE, ISE, etc.), Securities Information Processors (SIP), and other options market infrastructure for derivatives trading.", + "operationId": "get_options_v1_exchanges", + "parameters": [ + { + "description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '999'.", + "in": "query", + "name": "limit", + "schema": { + "default": 100, + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "count": 2, + "request_id": 1, + "results": [ + { + "id": "302", + "locale": "US", + "mic": "XCBO", + "name": "Chicago Board Options Exchange", + "operating_mic": "XCBO", + "participant_id": "C", + "type": "exchange", + "url": "https://www.cboe.com" + }, + { + "acronym": "ISE", + "id": "308", + "locale": "US", + "mic": "XISX", + "name": "International Securities Exchange, LLC", + "operating_mic": "XISX", + "participant_id": "I", + "type": "exchange", + "url": "https://www.nasdaq.com/solutions/nasdaq-ise" + } + ], + "status": "OK" + }, + "schema": { + "properties": { + "next_url": { + "description": "If present, this value can be used to fetch the next page.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "results": { + "description": "The results for this request.", + "items": { + "properties": { + "acronym": { + "description": "Exchange acronym or short name (e.g., 'ISE', 'GEMX') - may be null for some venues.", + "type": "string" + }, + "id": { + "description": "Numeric identifier for the options trading venue or exchange.", + "type": "string" + }, + "locale": { + "description": "Geographic location code.", + "type": "string" + }, + "mic": { + "description": "Market Identifier Code (MIC) - ISO 10383 standard four-character code identifying the specific options market.", + "type": "string" + }, + "name": { + "description": "Full official name of the options exchange or trading venue.", + "type": "string" + }, + "operating_mic": { + "description": "Operating Market Identifier Code - identifies the parent organization or operating entity.", + "type": "string" + }, + "participant_id": { + "description": "Single-character participant identifier used in consolidator market data feeds and options trade reporting.", + "type": "string" + }, + "type": { + "description": "Type of venue: 'exchange' for options exchanges, 'SIP' for Securities Information Processors like OPRA (Options Price Reporting Authority).", + "type": "string" + }, + "url": { + "description": "Official website URL of the organization operating the options exchange.", + "type": "string" + } + }, + "required": [ + "id", + "type", + "name" + ], + "type": "object" + }, + "type": "array" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "OK" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "results" + ], + "type": "object" + } + } + }, + "description": "A list of results." + }, + "400": { + "content": { + "application/json": { + "schema": { + "properties": { + "error": { + "description": "A message describing the source of the error.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "ERROR" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "error" + ], + "type": "object" + } + } + }, + "description": "An error message." + } + }, + "tags": [ + "default" + ] + } + }, + "/stocks/financials/v1/balance-sheets": { + "get": { + "description": "A comprehensive financial dataset containing quarterly and annual balance sheet data for public companies. Includes detailed asset, liability, and equity positions representing the company's financial position at specific points in time. Balance sheet data represents point-in-time snapshots rather than cumulative flows, showing what the company owns, owes, and shareholders' equity as of each period end date.", + "operationId": "get_stocks_financials_v1_balance-sheets", + "parameters": [ + { + "description": "The company's Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company's CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup).", + "in": "query", + "name": "cik", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "cik.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "cik.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "cik.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "cik.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "cik.lte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter for arrays that contain the value.", + "in": "query", + "name": "tickers", + "schema": { + "type": "string" + } + }, + { + "description": "Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "tickers.all_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "tickers.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "The last date of the reporting period, representing the specific point in time when the balance sheet snapshot was taken. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "period_end", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "period_end.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "period_end.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "period_end.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "period_end.lte", + "schema": { + "type": "string" + } + }, + { + "description": "The date when the financial statement was filed with the SEC. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "filing_date", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "filing_date.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "filing_date.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "filing_date.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "filing_date.lte", + "schema": { + "type": "string" + } + }, + { + "description": "The fiscal year for the reporting period. Value must be a floating point number.", + "in": "query", + "name": "fiscal_year", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "fiscal_year.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "fiscal_year.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "fiscal_year.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "fiscal_year.lte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "The fiscal quarter number (1, 2, 3, or 4) for the reporting period. Value must be a floating point number.", + "in": "query", + "name": "fiscal_quarter", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "fiscal_quarter.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "fiscal_quarter.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "fiscal_quarter.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "fiscal_quarter.lte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "The reporting period type. Possible values include: quarterly, annual.", + "in": "query", + "name": "timeframe", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "timeframe.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "timeframe.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "timeframe.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "timeframe.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "timeframe.lte", + "schema": { + "type": "string" + } + }, + { + "description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.", + "in": "query", + "name": "limit", + "schema": { + "default": 100, + "maximum": 50001, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'period_end' if not specified. The sort order defaults to 'asc' if not specified.", + "in": "query", + "name": "sort", + "schema": { + "default": "period_end.asc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "request_id": "d9f86384d43845a4a3d7b79098fb08dd", + "results": [ + { + "accounts_payable": 50374000000, + "accrued_and_other_current_liabilities": 62499000000, + "accumulated_other_comprehensive_income": -6369000000, + "cash_and_equivalents": 36269000000, + "cik": "0000320193", + "common_stock": 89806000000, + "debt_current": 19268000000, + "deferred_revenue_current": 8979000000, + "filing_date": "2025-08-01", + "fiscal_quarter": 3, + "fiscal_year": 2025, + "inventories": 5925000000, + "long_term_debt_and_capital_lease_obligations": 82430000000, + "other_assets": 160496000000, + "other_current_assets": 14359000000, + "other_equity": 0, + "other_noncurrent_liabilities": 42115000000, + "period_end": "2025-06-28", + "property_plant_equipment_net": 48508000000, + "receivables": 46835000000, + "retained_earnings_deficit": -17607000000, + "tickers": [ + "AAPL" + ], + "timeframe": "quarterly", + "total_assets": 331495000000, + "total_current_assets": 103388000000, + "total_current_liabilities": 141120000000, + "total_equity": 65830000000, + "total_equity_attributable_to_parent": 65830000000, + "total_liabilities": 265665000000, + "total_liabilities_and_equity": 331495000000 + } + ], + "status": "OK" + }, + "schema": { + "properties": { + "next_url": { + "description": "If present, this value can be used to fetch the next page.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "results": { + "description": "The results for this request.", + "items": { + "properties": { + "accounts_payable": { + "description": "Amounts owed to suppliers and vendors for goods and services purchased on credit.", + "format": "double", + "type": "number" + }, + "accrued_and_other_current_liabilities": { + "description": "Current liabilities not classified elsewhere, including accrued expenses, taxes payable, and other obligations due within one year.", + "format": "double", + "type": "number" + }, + "accumulated_other_comprehensive_income": { + "description": "Cumulative gains and losses that bypass the income statement, including foreign currency translation adjustments and unrealized gains/losses on securities.", + "format": "double", + "type": "number" + }, + "additional_paid_in_capital": { + "description": "Amount received from shareholders in excess of the par or stated value of shares issued.", + "format": "double", + "type": "number" + }, + "cash_and_equivalents": { + "description": "Cash on hand and short-term, highly liquid investments that are readily convertible to known amounts of cash.", + "format": "double", + "type": "number" + }, + "cik": { + "description": "The company's Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company's CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup).", + "type": "string" + }, + "commitments_and_contingencies": { + "description": "Disclosed amount related to contractual commitments and potential liabilities that may arise from uncertain future events.", + "format": "double", + "type": "number" + }, + "common_stock": { + "description": "Par or stated value of common shares outstanding representing basic ownership in the company.", + "format": "double", + "type": "number" + }, + "debt_current": { + "description": "Short-term borrowings and the current portion of long-term debt due within one year.", + "format": "double", + "type": "number" + }, + "deferred_revenue_current": { + "description": "Customer payments received in advance for goods or services to be delivered within one year.", + "format": "double", + "type": "number" + }, + "filing_date": { + "description": "The date when the financial statement was filed with the SEC.", + "format": "date", + "type": "string" + }, + "fiscal_quarter": { + "description": "The fiscal quarter number (1, 2, 3, or 4) for the reporting period.", + "format": "double", + "type": "number" + }, + "fiscal_year": { + "description": "The fiscal year for the reporting period.", + "format": "double", + "type": "number" + }, + "goodwill": { + "description": "Intangible asset representing the excess of purchase price over fair value of net assets acquired in business combinations.", + "format": "double", + "type": "number" + }, + "intangible_assets_net": { + "description": "Intangible assets other than goodwill, including patents, trademarks, and customer relationships, net of accumulated amortization.", + "format": "double", + "type": "number" + }, + "inventories": { + "description": "Raw materials, work-in-process, and finished goods held for sale in the ordinary course of business.", + "format": "double", + "type": "number" + }, + "long_term_debt_and_capital_lease_obligations": { + "description": "Long-term borrowings and capital lease obligations with maturities greater than one year.", + "format": "double", + "type": "number" + }, + "noncontrolling_interest": { + "description": "Equity in consolidated subsidiaries not owned by the parent company, representing minority shareholders' ownership.", + "format": "double", + "type": "number" + }, + "other_assets": { + "description": "Non-current assets not classified elsewhere, including long-term investments, deferred tax assets, and other long-term assets.", + "format": "double", + "type": "number" + }, + "other_current_assets": { + "description": "Current assets not classified elsewhere, including prepaid expenses, taxes receivable, and other assets expected to be converted to cash within one year.", + "format": "double", + "type": "number" + }, + "other_equity": { + "description": "Equity components not classified elsewhere in shareholders' equity.", + "format": "double", + "type": "number" + }, + "other_noncurrent_liabilities": { + "description": "Non-current liabilities not classified elsewhere, including deferred tax liabilities, pension obligations, and other long-term liabilities.", + "format": "double", + "type": "number" + }, + "period_end": { + "description": "The last date of the reporting period, representing the specific point in time when the balance sheet snapshot was taken.", + "format": "date", + "type": "string" + }, + "preferred_stock": { + "description": "Par or stated value of preferred shares outstanding with preferential rights over common stock.", + "format": "double", + "type": "number" + }, + "property_plant_equipment_net": { + "description": "Tangible fixed assets used in operations, reported net of accumulated depreciation.", + "format": "double", + "type": "number" + }, + "receivables": { + "description": "Amounts owed to the company by customers and other parties, primarily accounts receivable, net of allowances for doubtful accounts.", + "format": "double", + "type": "number" + }, + "retained_earnings_deficit": { + "description": "Cumulative net income earned by the company less dividends paid to shareholders since inception.", + "format": "double", + "type": "number" + }, + "short_term_investments": { + "description": "Marketable securities and other investments with maturities of one year or less that are not classified as cash equivalents.", + "format": "double", + "type": "number" + }, + "tickers": { + "description": "A list of ticker symbols under which the company is listed. Multiple symbols may indicate different share classes for the same company.", + "items": { + "type": "string" + }, + "type": "array" + }, + "timeframe": { + "description": "The reporting period type. Possible values include: quarterly, annual.", + "type": "string" + }, + "total_assets": { + "description": "Sum of all current and non-current assets representing everything the company owns or controls.", + "format": "double", + "type": "number" + }, + "total_current_assets": { + "description": "Sum of all current assets expected to be converted to cash, sold, or consumed within one year.", + "format": "double", + "type": "number" + }, + "total_current_liabilities": { + "description": "Sum of all liabilities expected to be settled within one year.", + "format": "double", + "type": "number" + }, + "total_equity": { + "description": "Sum of all equity components representing shareholders' total ownership interest in the company.", + "format": "double", + "type": "number" + }, + "total_equity_attributable_to_parent": { + "description": "Total shareholders' equity attributable to the parent company, excluding noncontrolling interests.", + "format": "double", + "type": "number" + }, + "total_liabilities": { + "description": "Sum of all current and non-current liabilities representing everything the company owes.", + "format": "double", + "type": "number" + }, + "total_liabilities_and_equity": { + "description": "Sum of total liabilities and total equity, which should equal total assets per the fundamental accounting equation.", + "format": "double", + "type": "number" + }, + "treasury_stock": { + "description": "Cost of the company's own shares that have been repurchased and are held in treasury, typically reported as a negative value.", + "format": "double", + "type": "number" + } + }, + "required": [ + "timeframe" + ], + "type": "object" + }, + "type": "array" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "OK" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "results" + ], + "type": "object" + } + } + }, + "description": "A list of results." + }, + "400": { + "content": { + "application/json": { + "schema": { + "properties": { + "error": { + "description": "A message describing the source of the error.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "ERROR" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "error" + ], + "type": "object" + } + } + }, + "description": "An error message." + } + }, + "tags": [ + "default" + ] + } + }, + "/stocks/financials/v1/cash-flow-statements": { + "get": { + "description": "A comprehensive financial dataset containing quarterly, annual, and trailing twelve-month cash flow statement data for public companies. Includes detailed operating, investing, and financing cash flows with proper TTM calculations that sum all cash flow components over four quarters. TTM records are validated to ensure exactly four distinct quarters spanning 250-400 days for accurate trailing twelve-month cash flow analysis.", + "operationId": "get_stocks_financials_v1_cash-flow-statements", + "parameters": [ + { + "description": "The company's Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company’s CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup).", + "in": "query", + "name": "cik", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "cik.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "cik.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "cik.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "cik.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "cik.lte", + "schema": { + "type": "string" + } + }, + { + "description": "The last date of the reporting period (formatted as YYYY-MM-DD). Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "period_end", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "period_end.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "period_end.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "period_end.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "period_end.lte", + "schema": { + "type": "string" + } + }, + { + "description": "The date when the financial statement was filed with the SEC. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "filing_date", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "filing_date.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "filing_date.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "filing_date.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "filing_date.lte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter for arrays that contain the value.", + "in": "query", + "name": "tickers", + "schema": { + "type": "string" + } + }, + { + "description": "Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "tickers.all_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "tickers.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "The fiscal year for the reporting period. Value must be a floating point number.", + "in": "query", + "name": "fiscal_year", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "fiscal_year.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "fiscal_year.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "fiscal_year.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "fiscal_year.lte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "The fiscal quarter number (1, 2, 3, or 4) for the reporting period. Value must be a floating point number.", + "in": "query", + "name": "fiscal_quarter", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "fiscal_quarter.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "fiscal_quarter.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "fiscal_quarter.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "fiscal_quarter.lte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "The reporting period type. Possible values include: quarterly, annual, trailing_twelve_months.", + "in": "query", + "name": "timeframe", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "timeframe.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "timeframe.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "timeframe.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "timeframe.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "timeframe.lte", + "schema": { + "type": "string" + } + }, + { + "description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.", + "in": "query", + "name": "limit", + "schema": { + "default": 100, + "maximum": 50001, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'period_end' if not specified. The sort order defaults to 'asc' if not specified.", + "in": "query", + "name": "sort", + "schema": { + "default": "period_end.asc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "request_id": "d6d389ca03a0450d93c4ecb13ff26dae", + "results": [ + { + "cash_from_operating_activities_continuing_operations": 27867000000, + "change_in_cash_and_equivalents": 8107000000, + "change_in_other_operating_assets_and_liabilities_net": -2034000000, + "cik": "0000320193", + "depreciation_depletion_and_amortization": 2830000000, + "dividends": -3945000000, + "filing_date": "2025-08-01", + "fiscal_quarter": 3, + "fiscal_year": 2025, + "long_term_debt_issuances_repayments": -1192000000, + "net_cash_from_financing_activities": -24833000000, + "net_cash_from_financing_activities_continuing_operations": -24833000000, + "net_cash_from_investing_activities": 5073000000, + "net_cash_from_investing_activities_continuing_operations": 5073000000, + "net_cash_from_operating_activities": 27867000000, + "net_income": 23434000000, + "other_financing_activities": -23599000000, + "other_investing_activities": 8535000000, + "other_operating_activities": 3637000000, + "period_end": "2025-06-28", + "purchase_of_property_plant_and_equipment": -3462000000, + "short_term_debt_issuances_repayments": 3903000000, + "tickers": [ + "AAPL" + ], + "timeframe": "quarterly" + } + ], + "status": "OK" + }, + "schema": { + "properties": { + "next_url": { + "description": "If present, this value can be used to fetch the next page.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "results": { + "description": "The results for this request.", + "items": { + "properties": { + "cash_from_operating_activities_continuing_operations": { + "description": "Cash generated from continuing business operations before discontinued operations.", + "format": "double", + "type": "number" + }, + "change_in_cash_and_equivalents": { + "description": "Net change in cash and cash equivalents during the period, representing the sum of operating, investing, and financing cash flows plus currency effects.", + "format": "double", + "type": "number" + }, + "change_in_other_operating_assets_and_liabilities_net": { + "description": "Net change in working capital components including accounts receivable, inventory, accounts payable, and other operating items.", + "format": "double", + "type": "number" + }, + "cik": { + "description": "The company's Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company’s CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup).", + "type": "string" + }, + "depreciation_depletion_and_amortization": { + "description": "Non-cash charges for the reduction in value of tangible and intangible assets over time.", + "format": "double", + "type": "number" + }, + "dividends": { + "description": "Cash payments to shareholders in the form of dividends, typically reported as negative values.", + "format": "double", + "type": "number" + }, + "effect_of_currency_exchange_rate": { + "description": "Impact of foreign exchange rate changes on cash and cash equivalents denominated in foreign currencies.", + "format": "double", + "type": "number" + }, + "filing_date": { + "description": "The date when the financial statement was filed with the SEC.", + "format": "date", + "type": "string" + }, + "fiscal_quarter": { + "description": "The fiscal quarter number (1, 2, 3, or 4) for the reporting period.", + "format": "double", + "type": "number" + }, + "fiscal_year": { + "description": "The fiscal year for the reporting period.", + "format": "double", + "type": "number" + }, + "income_loss_from_discontinued_operations": { + "description": "After-tax income or loss from business operations that have been discontinued.", + "format": "double", + "type": "number" + }, + "long_term_debt_issuances_repayments": { + "description": "Net cash flows from issuing or repaying long-term debt obligations.", + "format": "double", + "type": "number" + }, + "net_cash_from_financing_activities": { + "description": "Total cash generated or used by financing activities, including debt issuance, debt repayment, dividends, and share transactions.", + "format": "double", + "type": "number" + }, + "net_cash_from_financing_activities_continuing_operations": { + "description": "Cash flows from financing activities of continuing operations before discontinued operations.", + "format": "double", + "type": "number" + }, + "net_cash_from_financing_activities_discontinued_operations": { + "description": "Cash flows from financing activities of discontinued business segments.", + "format": "double", + "type": "number" + }, + "net_cash_from_investing_activities": { + "description": "Total cash generated or used by investing activities, including capital expenditures, acquisitions, and asset sales.", + "format": "double", + "type": "number" + }, + "net_cash_from_investing_activities_continuing_operations": { + "description": "Cash flows from investing activities of continuing operations before discontinued operations.", + "format": "double", + "type": "number" + }, + "net_cash_from_investing_activities_discontinued_operations": { + "description": "Cash flows from investing activities of discontinued business segments.", + "format": "double", + "type": "number" + }, + "net_cash_from_operating_activities": { + "description": "Total cash generated or used by operating activities, representing cash flow from core business operations.", + "format": "double", + "type": "number" + }, + "net_cash_from_operating_activities_discontinued_operations": { + "description": "Cash flows from operating activities of discontinued business segments.", + "format": "double", + "type": "number" + }, + "net_income": { + "description": "Net income used as the starting point for operating cash flow calculations.", + "format": "double", + "type": "number" + }, + "noncontrolling_interests": { + "description": "Cash flows related to minority shareholders in consolidated subsidiaries.", + "format": "double", + "type": "number" + }, + "other_cash_adjustments": { + "description": "Other miscellaneous adjustments to cash flows not classified elsewhere.", + "format": "double", + "type": "number" + }, + "other_financing_activities": { + "description": "Cash flows from financing activities not classified elsewhere, including share repurchases and other equity transactions.", + "format": "double", + "type": "number" + }, + "other_investing_activities": { + "description": "Cash flows from investing activities not classified elsewhere, including acquisitions, divestitures, and investments.", + "format": "double", + "type": "number" + }, + "other_operating_activities": { + "description": "Other adjustments to reconcile net income to operating cash flow not classified elsewhere.", + "format": "double", + "type": "number" + }, + "period_end": { + "description": "The last date of the reporting period (formatted as YYYY-MM-DD).", + "format": "date", + "type": "string" + }, + "purchase_of_property_plant_and_equipment": { + "description": "Cash outflows for capital expenditures on fixed assets, typically reported as negative values.", + "format": "double", + "type": "number" + }, + "sale_of_property_plant_and_equipment": { + "description": "Cash inflows from disposing of fixed assets, typically reported as positive values.", + "format": "double", + "type": "number" + }, + "short_term_debt_issuances_repayments": { + "description": "Net cash flows from issuing or repaying short-term debt obligations.", + "format": "double", + "type": "number" + }, + "tickers": { + "description": "A list of ticker symbols under which the company is listed. Multiple symbols may indicate different share classes for the same company.", + "items": { + "type": "string" + }, + "type": "array" + }, + "timeframe": { + "description": "The reporting period type. Possible values include: quarterly, annual, trailing_twelve_months.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "OK" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "results" + ], + "type": "object" + } + } + }, + "description": "A list of results." + }, + "400": { + "content": { + "application/json": { + "schema": { + "properties": { + "error": { + "description": "A message describing the source of the error.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "ERROR" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "error" + ], + "type": "object" + } + } + }, + "description": "An error message." + } + }, + "tags": [ + "default" + ] + } + }, + "/stocks/financials/v1/income-statements": { + "get": { + "description": "A comprehensive database of income statement financial data for public companies, including key metrics such as revenue, expenses, and net income for various reporting periods.", + "operationId": "get_stocks_financials_v1_income-statements", + "parameters": [ + { + "description": "The company's Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company’s CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup).", + "in": "query", + "name": "cik", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "cik.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "cik.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "cik.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "cik.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "cik.lte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter for arrays that contain the value.", + "in": "query", + "name": "tickers", + "schema": { + "type": "string" + } + }, + { + "description": "Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "tickers.all_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "tickers.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "The last date of the reporting period (formatted as YYYY-MM-DD). Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "period_end", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "period_end.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "period_end.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "period_end.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "period_end.lte", + "schema": { + "type": "string" + } + }, + { + "description": "The date when the financial statement was filed with the SEC. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "filing_date", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "filing_date.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "filing_date.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "filing_date.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value. Value must be formatted 'yyyy-mm-dd'.", + "in": "query", + "name": "filing_date.lte", + "schema": { + "type": "string" + } + }, + { + "description": "The fiscal year for the reporting period. Value must be a floating point number.", + "in": "query", + "name": "fiscal_year", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "fiscal_year.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "fiscal_year.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "fiscal_year.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "fiscal_year.lte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "The fiscal quarter number (1, 2, 3, or 4) for the reporting period. Value must be a floating point number.", + "in": "query", + "name": "fiscal_quarter", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "fiscal_quarter.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "fiscal_quarter.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "fiscal_quarter.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "fiscal_quarter.lte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "The reporting period type. Possible values include: quarterly, annual, trailing_twelve_months.", + "in": "query", + "name": "timeframe", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "timeframe.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "timeframe.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "timeframe.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "timeframe.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "timeframe.lte", + "schema": { + "type": "string" + } + }, + { + "description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.", + "in": "query", + "name": "limit", + "schema": { + "default": 100, + "maximum": 50001, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'period_end' if not specified. The sort order defaults to 'asc' if not specified.", + "in": "query", + "name": "sort", + "schema": { + "default": "period_end.asc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "request_id": "5b3cc7c674b34fdd89034b74500bfab5", + "results": [ + { + "basic_earnings_per_share": 1.57, + "basic_shares_outstanding": 14902886000, + "cik": "0000320193", + "consolidated_net_income_loss": 23434000000, + "cost_of_revenue": 50318000000, + "diluted_earnings_per_share": 1.57, + "diluted_shares_outstanding": 14948179000, + "ebitda": 31032000000, + "filing_date": "2025-08-01", + "fiscal_quarter": 3, + "fiscal_year": 2025, + "gross_profit": 43718000000, + "income_before_income_taxes": 28031000000, + "income_taxes": 4597000000, + "net_income_loss_attributable_common_shareholders": 23434000000, + "operating_income": 28202000000, + "other_income_expense": -171000000, + "other_operating_expenses": 0, + "period_end": "2025-06-28", + "research_development": 8866000000, + "revenue": 94036000000, + "selling_general_administrative": 6650000000, + "tickers": [ + "AAPL" + ], + "timeframe": "quarterly", + "total_operating_expenses": 15516000000, + "total_other_income_expense": -171000000 + } + ], + "status": "OK" + }, + "schema": { + "properties": { + "next_url": { + "description": "If present, this value can be used to fetch the next page.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "results": { + "description": "The results for this request.", + "items": { + "properties": { + "basic_earnings_per_share": { + "description": "Earnings per share calculated using the weighted average number of basic shares outstanding. For TTM records, recalculated as TTM net income divided by average basic shares outstanding over the four quarters.", + "format": "double", + "type": "number" + }, + "basic_shares_outstanding": { + "description": "Weighted average number of common shares outstanding during the period, used in basic EPS calculation. For TTM records, represents the average over the four most recent quarters.", + "format": "double", + "type": "number" + }, + "cik": { + "description": "The company's Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company’s CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup).", + "type": "string" + }, + "consolidated_net_income_loss": { + "description": "Total net income or loss for the consolidated entity including all subsidiaries.", + "format": "double", + "type": "number" + }, + "cost_of_revenue": { + "description": "Direct costs attributable to the production of goods or services sold, also known as cost of goods sold (COGS).", + "format": "double", + "type": "number" + }, + "depreciation_depletion_amortization": { + "description": "Non-cash expenses representing the allocation of asset costs over their useful lives.", + "format": "double", + "type": "number" + }, + "diluted_earnings_per_share": { + "description": "Earnings per share calculated using diluted shares outstanding, including the effect of potentially dilutive securities. For TTM records, recalculated as TTM net income divided by average diluted shares outstanding over the four quarters.", + "format": "double", + "type": "number" + }, + "diluted_shares_outstanding": { + "description": "Weighted average number of shares outstanding including the dilutive effect of stock options, warrants, and convertible securities. For TTM records, represents the average over the four most recent quarters.", + "format": "double", + "type": "number" + }, + "discontinued_operations": { + "description": "After-tax results from business segments that have been or will be disposed of.", + "format": "double", + "type": "number" + }, + "ebitda": { + "description": "Earnings before interest, taxes, depreciation, and amortization, a measure of operating performance.", + "format": "double", + "type": "number" + }, + "equity_in_affiliates": { + "description": "The company's share of income or losses from equity method investments in affiliated companies.", + "format": "double", + "type": "number" + }, + "extraordinary_items": { + "description": "Unusual and infrequent gains or losses that are both unusual in nature and infrequent in occurrence.", + "format": "double", + "type": "number" + }, + "filing_date": { + "description": "The date when the financial statement was filed with the SEC.", + "format": "date", + "type": "string" + }, + "fiscal_quarter": { + "description": "The fiscal quarter number (1, 2, 3, or 4) for the reporting period.", + "format": "double", + "type": "number" + }, + "fiscal_year": { + "description": "The fiscal year for the reporting period.", + "format": "double", + "type": "number" + }, + "gross_profit": { + "description": "Revenue minus cost of revenue, representing profit before operating expenses.", + "format": "double", + "type": "number" + }, + "income_before_income_taxes": { + "description": "Pre-tax income calculated as operating income plus total other income/expense.", + "format": "double", + "type": "number" + }, + "income_taxes": { + "description": "Income tax expense or benefit for the period.", + "format": "double", + "type": "number" + }, + "interest_expense": { + "description": "Cost of borrowed funds, including interest on debt and other financing obligations.", + "format": "double", + "type": "number" + }, + "interest_income": { + "description": "Income earned from interest-bearing investments and cash equivalents.", + "format": "double", + "type": "number" + }, + "net_income_loss_attributable_common_shareholders": { + "description": "Net income or loss available to common shareholders after preferred dividends and noncontrolling interests.", + "format": "double", + "type": "number" + }, + "noncontrolling_interest": { + "description": "The portion of net income attributable to minority shareholders in consolidated subsidiaries.", + "format": "double", + "type": "number" + }, + "operating_income": { + "description": "Income from operations calculated as gross profit minus total operating expenses, excluding non-operating items.", + "format": "double", + "type": "number" + }, + "other_income_expense": { + "description": "Non-operating income and expenses not related to the company's core business operations.", + "format": "double", + "type": "number" + }, + "other_operating_expenses": { + "description": "Operating expenses not classified in the main expense categories.", + "format": "double", + "type": "number" + }, + "period_end": { + "description": "The last date of the reporting period (formatted as YYYY-MM-DD).", + "format": "date", + "type": "string" + }, + "preferred_stock_dividends_declared": { + "description": "Dividends declared on preferred stock during the period.", + "format": "double", + "type": "number" + }, + "research_development": { + "description": "Expenses incurred for research and development activities to create new products or improve existing ones.", + "format": "double", + "type": "number" + }, + "revenue": { + "description": "Total revenue or net sales for the period, representing the company's gross income from operations.", + "format": "double", + "type": "number" + }, + "selling_general_administrative": { + "description": "Expenses related to selling products and general administrative costs not directly tied to production.", + "format": "double", + "type": "number" + }, + "tickers": { + "description": "A list of ticker symbols under which the company is listed. Multiple symbols may indicate different share classes for the same company.", + "items": { + "type": "string" + }, + "type": "array" + }, + "timeframe": { + "description": "The reporting period type. Possible values include: quarterly, annual, trailing_twelve_months.", + "type": "string" + }, + "total_operating_expenses": { + "description": "Sum of all operating expenses including cost of revenue, SG&A, R&D, depreciation, and other operating expenses.", + "format": "double", + "type": "number" + }, + "total_other_income_expense": { + "description": "Net total of all non-operating income and expenses including interest income, interest expense, and other items.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "type": "array" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "OK" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "results" + ], + "type": "object" + } + } + }, + "description": "A list of results." + }, + "400": { + "content": { + "application/json": { + "schema": { + "properties": { + "error": { + "description": "A message describing the source of the error.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "ERROR" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "error" + ], + "type": "object" + } + } + }, + "description": "An error message." + } + }, + "tags": [ + "default" + ] + } + }, + "/stocks/financials/v1/ratios": { + "get": { + "description": "A comprehensive financial ratios dataset providing key valuation, profitability, liquidity, and leverage metrics for public companies. Combines data from income statements, balance sheets, and cash flow statements with daily stock prices to calculate ratios on a daily basis. Uses trailing twelve months (TTM) data for income/cash flow metrics and quarterly data for balance sheet items. Fundamental data updates are applied starting from each filing's period end date. Market cap calculations use point-in-time shares outstanding for historical accuracy.", + "operationId": "get_stocks_financials_v1_ratios", + "parameters": [ + { + "description": "Stock ticker symbol for the company.", + "in": "query", + "name": "ticker", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "ticker.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "ticker.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "ticker.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "ticker.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "ticker.lte", + "schema": { + "type": "string" + } + }, + { + "description": "Central Index Key (CIK) number assigned by the SEC to identify the company.", + "in": "query", + "name": "cik", + "schema": { + "type": "string" + } + }, + { + "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list.", + "in": "query", + "name": "cik.any_of", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than the value.", + "in": "query", + "name": "cik.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter greater than or equal to the value.", + "in": "query", + "name": "cik.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than the value.", + "in": "query", + "name": "cik.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Filter less than or equal to the value.", + "in": "query", + "name": "cik.lte", + "schema": { + "type": "string" + } + }, + { + "description": "Stock price used in ratio calculations, typically the closing price for the given date. Value must be a floating point number.", + "in": "query", + "name": "price", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "price.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "price.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "price.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "price.lte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Average trading volume over the last 30 trading days, providing context for liquidity. Value must be a floating point number.", + "in": "query", + "name": "average_volume", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "average_volume.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "average_volume.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "average_volume.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "average_volume.lte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Market capitalization, calculated as stock price multiplied by total shares outstanding. Value must be a floating point number.", + "in": "query", + "name": "market_cap", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "market_cap.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "market_cap.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "market_cap.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "market_cap.lte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Earnings per share, calculated as net income available to common shareholders divided by weighted shares outstanding. Value must be a floating point number.", + "in": "query", + "name": "earnings_per_share", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "earnings_per_share.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "earnings_per_share.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "earnings_per_share.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "earnings_per_share.lte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Price-to-earnings ratio, calculated as stock price divided by earnings per share. Only calculated when earnings per share is positive. Value must be a floating point number.", + "in": "query", + "name": "price_to_earnings", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "price_to_earnings.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "price_to_earnings.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "price_to_earnings.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "price_to_earnings.lte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Price-to-book ratio, calculated as stock price divided by book value per share, comparing market value to book value. Value must be a floating point number.", + "in": "query", + "name": "price_to_book", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "price_to_book.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "price_to_book.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "price_to_book.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "price_to_book.lte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Price-to-sales ratio, calculated as stock price divided by revenue per share, measuring valuation relative to sales. Value must be a floating point number.", + "in": "query", + "name": "price_to_sales", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "price_to_sales.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "price_to_sales.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "price_to_sales.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "price_to_sales.lte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Price-to-cash-flow ratio, calculated as stock price divided by operating cash flow per share. Only calculated when operating cash flow per share is positive. Value must be a floating point number.", + "in": "query", + "name": "price_to_cash_flow", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "price_to_cash_flow.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "price_to_cash_flow.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "price_to_cash_flow.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "price_to_cash_flow.lte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Price-to-free-cash-flow ratio, calculated as stock price divided by free cash flow per share. Only calculated when free cash flow per share is positive. Value must be a floating point number.", + "in": "query", + "name": "price_to_free_cash_flow", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "price_to_free_cash_flow.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "price_to_free_cash_flow.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "price_to_free_cash_flow.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "price_to_free_cash_flow.lte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Dividend yield, calculated as annual dividends per share divided by stock price, measuring the income return on investment. Value must be a floating point number.", + "in": "query", + "name": "dividend_yield", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "dividend_yield.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "dividend_yield.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "dividend_yield.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "dividend_yield.lte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Return on assets ratio, calculated as net income divided by total assets, measuring how efficiently a company uses its assets to generate profit. Value must be a floating point number.", + "in": "query", + "name": "return_on_assets", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "return_on_assets.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "return_on_assets.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "return_on_assets.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "return_on_assets.lte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Return on equity ratio, calculated as net income divided by total shareholders' equity, measuring profitability relative to shareholders' equity. Value must be a floating point number.", + "in": "query", + "name": "return_on_equity", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "return_on_equity.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "return_on_equity.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "return_on_equity.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "return_on_equity.lte", + "schema": { + "format": "double", + "type": "number" + } + }, { - "description": "The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract).", - "example": "GCJ5", - "in": "path", - "name": "ticker", - "required": true, + "description": "Debt-to-equity ratio, calculated as total debt (current debt plus long-term debt) divided by total shareholders' equity, measuring financial leverage. Value must be a floating point number.", + "in": "query", + "name": "debt_to_equity", "schema": { - "type": "string" - }, - "x-polygon-go-id": "Ticker" + "format": "double", + "type": "number" + } }, { - "description": "Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp.", + "description": "Filter greater than the value. Value must be a floating point number.", "in": "query", - "name": "timestamp", + "name": "debt_to_equity.gt", "schema": { - "type": "string" - }, - "x-polygon-filter-field": { - "range": true + "format": "double", + "type": "number" } }, { - "description": "Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format.", + "description": "Filter greater than or equal to the value. Value must be a floating point number.", "in": "query", - "name": "session_end_date", + "name": "debt_to_equity.gte", "schema": { - "type": "string" - }, - "x-polygon-filter-field": { - "range": true + "format": "double", + "type": "number" } }, { - "description": "The number of results to return per page (default=1000, maximum=50000, minimum=1).", + "description": "Filter less than the value. Value must be a floating point number.", "in": "query", - "name": "limit", + "name": "debt_to_equity.lt", "schema": { - "default": 1000, - "maximum": 50000, - "minimum": 1, - "type": "integer" + "format": "double", + "type": "number" } }, { - "description": "Range by timestamp.", + "description": "Filter less than or equal to the value. Value must be a floating point number.", "in": "query", - "name": "timestamp.gte", + "name": "debt_to_equity.lte", "schema": { - "type": "string" + "format": "double", + "type": "number" } }, { - "description": "Range by timestamp.", + "description": "Current ratio, calculated as total current assets divided by total current liabilities, measuring short-term liquidity. Value must be a floating point number.", "in": "query", - "name": "timestamp.gt", + "name": "current", "schema": { - "type": "string" + "format": "double", + "type": "number" } }, { - "description": "Range by timestamp.", + "description": "Filter greater than the value. Value must be a floating point number.", "in": "query", - "name": "timestamp.lte", + "name": "current.gt", "schema": { - "type": "string" + "format": "double", + "type": "number" } }, { - "description": "Range by timestamp.", + "description": "Filter greater than or equal to the value. Value must be a floating point number.", "in": "query", - "name": "timestamp.lt", + "name": "current.gte", "schema": { - "type": "string" + "format": "double", + "type": "number" } }, { - "description": "Range by session_end_date.", + "description": "Filter less than the value. Value must be a floating point number.", "in": "query", - "name": "session_end_date.gte", + "name": "current.lt", "schema": { - "type": "string" + "format": "double", + "type": "number" } }, { - "description": "Range by session_end_date.", + "description": "Filter less than or equal to the value. Value must be a floating point number.", "in": "query", - "name": "session_end_date.gt", + "name": "current.lte", "schema": { - "type": "string" + "format": "double", + "type": "number" } }, { - "description": "Range by session_end_date.", + "description": "Quick ratio (acid-test ratio), calculated as (current assets minus inventories) divided by current liabilities, measuring immediate liquidity. Value must be a floating point number.", "in": "query", - "name": "session_end_date.lte", + "name": "quick", "schema": { - "type": "string" + "format": "double", + "type": "number" } }, { - "description": "Range by session_end_date.", + "description": "Filter greater than the value. Value must be a floating point number.", "in": "query", - "name": "session_end_date.lt", + "name": "quick.gt", "schema": { - "type": "string" + "format": "double", + "type": "number" } }, { - "description": "Sort results by field and direction using dotted notation (e.g., 'ticker.asc', 'name.desc').", + "description": "Filter greater than or equal to the value. Value must be a floating point number.", "in": "query", - "name": "sort", + "name": "quick.gte", "schema": { - "default": "timestamp.desc", - "enum": [ - "timestamp.asc", - "timestamp.desc" - ], - "example": "timestamp.desc", - "type": "string" + "format": "double", + "type": "number" } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "example": { - "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3", - "results": [ - { - "ask_price": 604075, - "ask_size": 6, - "ask_timestamp": 1734467086235923000, - "bid_price": 604075, - "bid_size": 6, - "bid_timestamp": 1734415473057885400, - "session_end_date": "2024-12-17", - "ticker": "ESZ4", - "timestamp": 1734476400002853000 - }, - { - "ask_price": 604100, - "ask_size": 2, - "ask_timestamp": 1734466901129138400, - "bid_price": 604100, - "bid_size": 2, - "bid_timestamp": 1734415473057885400, - "session_end_date": "2024-12-17", - "ticker": "ESZ4", - "timestamp": 1734466901128680000 - } - ], - "status": "OK" - }, - "schema": { - "properties": { - "next_url": { - "description": "If present, this value can be used to fetch the next page of data.", - "type": "string" - }, - "results": { - "items": { - "properties": { - "ask_price": { - "description": "The ask price is expressed per unit of the underlying asset, and you apply the contract multiplier to get the full contract value.", - "format": "double", - "type": "number" - }, - "ask_size": { - "description": "The quote size represents the number of futures contracts available at the given ask price.", - "format": "double", - "type": "number" - }, - "ask_timestamp": { - "description": "The time when the ask price was submitted to the exchange.", - "type": "integer", - "x-polygon-go-type": { - "name": "IMilliseconds", - "path": "github.com/polygon-io/ptime" - } - }, - "bid_price": { - "description": "The bid price is expressed per unit of the underlying asset, and you apply the contract multiplier to get the full contract value.", - "format": "double", - "type": "number" - }, - "bid_size": { - "description": "The quote size represents the number of futures contracts available at the given bid price.", - "format": "double", - "type": "number" - }, - "bid_timestamp": { - "description": "The time when the bid price was submitted to the exchange.", - "type": "integer", - "x-polygon-go-type": { - "name": "IMilliseconds", - "path": "github.com/polygon-io/ptime" - } - }, - "session_end_date": { - "description": "Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format.", - "type": "string" - }, - "ticker": { - "description": "The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract).", - "type": "string" - }, - "timestamp": { - "description": "The time when the quote was generated at the exchange to nanosecond precision.", - "type": "integer", - "x-polygon-go-type": { - "name": "IMilliseconds", - "path": "github.com/polygon-io/ptime" - } - } - }, - "required": [ - "price", - "size" - ], - "type": "object", - "x-polygon-go-type": { - "name": "Futures" - } - }, - "type": "array" - }, - "status": { - "description": "The status of this request's response.", - "type": "string" - } - }, - "required": [ - "status" - ], - "type": "object" - } - } - }, - "description": "A list of quotes." - } - }, - "summary": "Quotes", - "tags": [ - "default" - ], - "x-polygon-entitlement-data-type": { - "description": "Futures quotes data", - "name": "nbbo" - }, - "x-polygon-entitlement-market-type": { - "description": "Futures data", - "name": "futures" - }, - "x-polygon-replaces": { - "date": 1654056060000, - "replaces": { - "name": "Quotes", - "path": "get_v1_us_futures_quotes__ticker___date" - } - } - } - }, - "/futures/vX/schedules": { - "get": { - "description": "The Trading-Date Based Futures Schedules API provides detailed trading schedules for all products on a specific day. This API allows you to retrieve detailed information about trading sessions, including market events like preopen, open, and closed, along with their precise timestamps.", - "operationId": "GetFuturesDailySchedules", - "parameters": [ + }, { - "description": "The session end date for the schedules (also known as the trading date). This is the day in CT for which the user wants to retrieve data. If left blank, this value defaults to 'today' in Central Time. e.g. If a request is made from Pacific Time on '2025-01-01' at 11:00 pm with no 'session_end_date' a default value of `2025-01-02` will be used.", + "description": "Filter less than the value. Value must be a floating point number.", "in": "query", - "name": "session_end_date", + "name": "quick.lt", "schema": { - "format": "date", - "type": "string" + "format": "double", + "type": "number" } }, { - "description": "The trading venue (MIC) of the exchange for the schedules.", + "description": "Filter less than or equal to the value. Value must be a floating point number.", "in": "query", - "name": "trading_venue", + "name": "quick.lte", "schema": { - "type": "string" + "format": "double", + "type": "number" } }, { - "description": "The number of results to return per page (default=100, max=1000, min=1).", + "description": "Cash ratio, calculated as cash and cash equivalents divided by current liabilities, measuring the most liquid form of liquidity coverage. Value must be a floating point number.", "in": "query", - "name": "limit", + "name": "cash", "schema": { - "default": 100, - "maximum": 1000, - "minimum": 1, - "type": "integer" + "format": "double", + "type": "number" } }, { - "description": "Sort results by field and direction using dotted notation (e.g., 'ticker.asc', 'name.desc').", + "description": "Filter greater than the value. Value must be a floating point number.", "in": "query", - "name": "sort", + "name": "cash.gt", "schema": { - "default": "trading_venue.asc", - "enum": [ - "trading_venue.asc", - "trading_venue.desc" - ], - "example": "trading_venue.asc", - "type": "string" + "format": "double", + "type": "number" } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "example": { - "next_url": "http://api.polygon.io/futures/vX/schedules?cursor=YXA9MUUmYXM9WE5ZTSZsaW1pdD0yJm9yZGVyPWFzYyZzb3J0PXByb2R1Y3RfY29kZSZ0cmFkaW5nX2RhdGU9MjAyNC0xMS0yNQ", - "request_id": "000a000a0a0a000a0a0aa00a0a0000a0", - "results": [ - { - "product_code": "10Y", - "product_name": "10-YEAR YIELD CAL SPD", - "schedule": [ - { - "event": "pre_open", - "timestamp": "2025-07-06T16:00:00-05:00" - }, - { - "event": "open", - "timestamp": "2025-07-06T17:00:00-05:00" - }, - { - "event": "close", - "timestamp": "2025-07-07T16:00:00-05:00" - } - ], - "session_end_date": "2025-07-07", - "trading_venue": "XCBT" - }, - { - "product_code": "10Y", - "product_name": "10-Year Yield Futures", - "schedule": [ - { - "event": "pre_open", - "timestamp": "2025-07-06T16:00:00-05:00" - }, - { - "event": "open", - "timestamp": "2025-07-06T17:00:00-05:00" - }, - { - "event": "close", - "timestamp": "2025-07-07T16:00:00-05:00" - } - ], - "session_end_date": "2025-07-07", - "trading_venue": "XCBT" - } - ], - "status": "OK" - }, - "schema": { - "properties": { - "next_url": { - "description": "The URL for the next page of results.", - "type": "string" - }, - "request_id": { - "description": "The unique identifier for this request.", - "type": "string" - }, - "results": { - "description": "A list of schedules for each product.", - "items": { - "properties": { - "product_code": { - "description": "The product code for the futures product to which this schedule applies.", - "type": "string" - }, - "product_name": { - "description": "The name of the futures product to which this schedule applies.", - "type": "string" - }, - "schedule": { - "items": { - "properties": { - "event": { - "description": "The market event for this schedule.", - "enum": [ - "pre_open", - "open", - "close", - "pause", - "post_close_pre_open" - ], - "type": "string" - }, - "timestamp": { - "description": "The timestamp for this market event in Central Time.", - "format": "time", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "session_end_date": { - "description": "The date on which the schedule's trading day ended (sometimes referred to as trading date) formatted as `YYYY-MM-DD`. Note that although there is no time component on this attribute, the day refers to Central Time.", - "format": "date", - "type": "string" - }, - "trading_venue": { - "description": "The trading venue (MIC) for the exchange on which this schedule's product trades.", - "type": "string" - } - }, - "type": "object", - "x-polygon-go-type": { - "name": "SchedulesResult" - } - }, - "type": "array" - }, - "status": { - "description": "The status of the response.", - "type": "string" - } - }, - "type": "object" - } - } - }, - "description": "A list of schedules for a given day." - } - }, - "summary": "Daily Schedules", - "tags": [ - "default" - ], - "x-polygon-entitlement-data-type": { - "description": "Reference data", - "name": "reference" - } - } - }, - "/futures/vX/trades/{ticker}": { - "get": { - "description": "Get trades for a contract in a given time range.", - "operationId": "GetFuturesTrades", - "parameters": [ + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "cash.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "cash.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "cash.lte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Enterprise value to sales ratio, calculated as enterprise value divided by revenue, measuring company valuation relative to sales. Value must be a floating point number.", + "in": "query", + "name": "ev_to_sales", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "ev_to_sales.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "ev_to_sales.gte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "ev_to_sales.lt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter less than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "ev_to_sales.lte", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Enterprise value to EBITDA ratio, calculated as enterprise value divided by EBITDA, measuring company valuation relative to earnings before interest, taxes, depreciation, and amortization. Value must be a floating point number.", + "in": "query", + "name": "ev_to_ebitda", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than the value. Value must be a floating point number.", + "in": "query", + "name": "ev_to_ebitda.gt", + "schema": { + "format": "double", + "type": "number" + } + }, + { + "description": "Filter greater than or equal to the value. Value must be a floating point number.", + "in": "query", + "name": "ev_to_ebitda.gte", + "schema": { + "format": "double", + "type": "number" + } + }, { - "description": "The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract).", - "example": "GCJ5", - "in": "path", - "name": "ticker", - "required": true, + "description": "Filter less than the value. Value must be a floating point number.", + "in": "query", + "name": "ev_to_ebitda.lt", "schema": { - "type": "string" - }, - "x-polygon-go-id": "Ticker" + "format": "double", + "type": "number" + } }, { - "description": "Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp.", + "description": "Filter less than or equal to the value. Value must be a floating point number.", "in": "query", - "name": "timestamp", + "name": "ev_to_ebitda.lte", "schema": { - "type": "string" - }, - "x-polygon-filter-field": { - "range": true + "format": "double", + "type": "number" } }, { - "description": "Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format.", + "description": "Enterprise value, calculated as market capitalization plus total debt minus cash and cash equivalents, representing total company value. Value must be a floating point number.", "in": "query", - "name": "session_end_date", + "name": "enterprise_value", "schema": { - "type": "string" - }, - "x-polygon-filter-field": { - "range": true + "format": "double", + "type": "number" } }, { - "description": "The number of results to return per page (default=1000, maximum=50000, minimum=1).", + "description": "Filter greater than the value. Value must be a floating point number.", "in": "query", - "name": "limit", + "name": "enterprise_value.gt", "schema": { - "default": 1000, - "maximum": 50000, - "minimum": 1, - "type": "integer" + "format": "double", + "type": "number" } }, { - "description": "Range by timestamp.", + "description": "Filter greater than or equal to the value. Value must be a floating point number.", "in": "query", - "name": "timestamp.gte", + "name": "enterprise_value.gte", "schema": { - "type": "string" + "format": "double", + "type": "number" } }, { - "description": "Range by timestamp.", + "description": "Filter less than the value. Value must be a floating point number.", "in": "query", - "name": "timestamp.gt", + "name": "enterprise_value.lt", "schema": { - "type": "string" + "format": "double", + "type": "number" } }, { - "description": "Range by timestamp.", + "description": "Filter less than or equal to the value. Value must be a floating point number.", "in": "query", - "name": "timestamp.lte", + "name": "enterprise_value.lte", "schema": { - "type": "string" + "format": "double", + "type": "number" } }, { - "description": "Range by timestamp.", + "description": "Free cash flow, calculated as operating cash flow minus capital expenditures (purchase of property, plant, and equipment). Value must be a floating point number.", "in": "query", - "name": "timestamp.lt", + "name": "free_cash_flow", "schema": { - "type": "string" + "format": "double", + "type": "number" } }, { - "description": "Range by session_end_date.", + "description": "Filter greater than the value. Value must be a floating point number.", "in": "query", - "name": "session_end_date.gte", + "name": "free_cash_flow.gt", "schema": { - "type": "string" + "format": "double", + "type": "number" } }, { - "description": "Range by session_end_date.", + "description": "Filter greater than or equal to the value. Value must be a floating point number.", "in": "query", - "name": "session_end_date.gt", + "name": "free_cash_flow.gte", "schema": { - "type": "string" + "format": "double", + "type": "number" } }, { - "description": "Range by session_end_date.", + "description": "Filter less than the value. Value must be a floating point number.", "in": "query", - "name": "session_end_date.lte", + "name": "free_cash_flow.lt", "schema": { - "type": "string" + "format": "double", + "type": "number" } }, { - "description": "Range by session_end_date.", + "description": "Filter less than or equal to the value. Value must be a floating point number.", "in": "query", - "name": "session_end_date.lt", + "name": "free_cash_flow.lte", "schema": { - "type": "string" + "format": "double", + "type": "number" } }, { - "description": "Sort results by field and direction using dotted notation (e.g., 'ticker.asc', 'name.desc').", + "description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'.", + "in": "query", + "name": "limit", + "schema": { + "default": 100, + "maximum": 50001, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'ticker' if not specified. The sort order defaults to 'asc' if not specified.", "in": "query", "name": "sort", "schema": { - "default": "timestamp.desc", - "enum": [ - "timestamp.asc", - "timestamp.desc" - ], - "example": "timestamp.desc", + "default": "ticker.asc", "type": "string" } } @@ -11645,28 +20189,33 @@ "content": { "application/json": { "example": { - "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3", + "count": 1, + "request_id": "8f5374516fec4a819070e53609f47fab", "results": [ { - "price": 605400, - "session_end_date": "2024-12-17", - "size": 12, - "ticker": "ESZ4", - "timestamp": 1734484219379895800 - }, - { - "price": 605412, - "session_end_date": "2024-12-17", - "size": 55, - "ticker": "ESZ4", - "timestamp": 1734484212100118500 - }, - { - "price": 605544, - "session_end_date": "2024-12-17", - "size": 36, - "ticker": "ESZ4", - "timestamp": 1734484212099944200 + "average_volume": 47500000, + "cash": 0.19, + "cik": "320193", + "current": 0.68, + "date": "2024-09-19", + "debt_to_equity": 1.52, + "dividend_yield": 0.0044, + "earnings_per_share": 6.57, + "enterprise_value": 3555509835190, + "ev_to_ebitda": 26.98, + "ev_to_sales": 9.22, + "free_cash_flow": 104339000000, + "market_cap": 3479770835190, + "price": 228.87, + "price_to_book": 52.16, + "price_to_cash_flow": 30.78, + "price_to_earnings": 34.84, + "price_to_free_cash_flow": 33.35, + "price_to_sales": 9.02, + "quick": 0.63, + "return_on_assets": 0.3075, + "return_on_equity": 1.5284, + "ticker": "AAPL" } ], "status": "OK" @@ -11674,88 +20223,364 @@ "schema": { "properties": { "next_url": { - "description": "If present, this value can be used to fetch the next page of data.", + "description": "If present, this value can be used to fetch the next page.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", "type": "string" }, "results": { + "description": "The results for this request.", "items": { "properties": { - "price": { - "description": "The price of the trade. This is the actual dollar value per whole contract of this trade. A trade of 100 contracts with a price of $2.00 would be worth a total dollar value of $200.00.", + "average_volume": { + "description": "Average trading volume over the last 30 trading days, providing context for liquidity.", "format": "double", "type": "number" }, - "session_end_date": { - "description": "Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format.", + "cash": { + "description": "Cash ratio, calculated as cash and cash equivalents divided by current liabilities, measuring the most liquid form of liquidity coverage.", + "format": "double", + "type": "number" + }, + "cik": { + "description": "Central Index Key (CIK) number assigned by the SEC to identify the company.", "type": "string" }, - "size": { - "description": "The total number of contracts exchanged between buyers and sellers on a given trade.", + "current": { + "description": "Current ratio, calculated as total current assets divided by total current liabilities, measuring short-term liquidity.", "format": "double", "type": "number" }, - "ticker": { - "description": "ticker of the trade", + "date": { + "description": "Date for which the ratios are calculated, representing the trading date with available price data.", "type": "string" }, - "timestamp": { - "description": "The time when the trade was generated at the exchange to nanosecond precision.", - "type": "integer", - "x-polygon-go-type": { - "name": "IMilliseconds", - "path": "github.com/polygon-io/ptime" - } + "debt_to_equity": { + "description": "Debt-to-equity ratio, calculated as total debt (current debt plus long-term debt) divided by total shareholders' equity, measuring financial leverage.", + "format": "double", + "type": "number" + }, + "dividend_yield": { + "description": "Dividend yield, calculated as annual dividends per share divided by stock price, measuring the income return on investment.", + "format": "double", + "type": "number" + }, + "earnings_per_share": { + "description": "Earnings per share, calculated as net income available to common shareholders divided by weighted shares outstanding.", + "format": "double", + "type": "number" + }, + "enterprise_value": { + "description": "Enterprise value, calculated as market capitalization plus total debt minus cash and cash equivalents, representing total company value.", + "format": "double", + "type": "number" + }, + "ev_to_ebitda": { + "description": "Enterprise value to EBITDA ratio, calculated as enterprise value divided by EBITDA, measuring company valuation relative to earnings before interest, taxes, depreciation, and amortization.", + "format": "double", + "type": "number" + }, + "ev_to_sales": { + "description": "Enterprise value to sales ratio, calculated as enterprise value divided by revenue, measuring company valuation relative to sales.", + "format": "double", + "type": "number" + }, + "free_cash_flow": { + "description": "Free cash flow, calculated as operating cash flow minus capital expenditures (purchase of property, plant, and equipment).", + "format": "double", + "type": "number" + }, + "market_cap": { + "description": "Market capitalization, calculated as stock price multiplied by total shares outstanding.", + "format": "double", + "type": "number" + }, + "price": { + "description": "Stock price used in ratio calculations, typically the closing price for the given date.", + "format": "double", + "type": "number" + }, + "price_to_book": { + "description": "Price-to-book ratio, calculated as stock price divided by book value per share, comparing market value to book value.", + "format": "double", + "type": "number" + }, + "price_to_cash_flow": { + "description": "Price-to-cash-flow ratio, calculated as stock price divided by operating cash flow per share. Only calculated when operating cash flow per share is positive.", + "format": "double", + "type": "number" + }, + "price_to_earnings": { + "description": "Price-to-earnings ratio, calculated as stock price divided by earnings per share. Only calculated when earnings per share is positive.", + "format": "double", + "type": "number" + }, + "price_to_free_cash_flow": { + "description": "Price-to-free-cash-flow ratio, calculated as stock price divided by free cash flow per share. Only calculated when free cash flow per share is positive.", + "format": "double", + "type": "number" + }, + "price_to_sales": { + "description": "Price-to-sales ratio, calculated as stock price divided by revenue per share, measuring valuation relative to sales.", + "format": "double", + "type": "number" + }, + "quick": { + "description": "Quick ratio (acid-test ratio), calculated as (current assets minus inventories) divided by current liabilities, measuring immediate liquidity.", + "format": "double", + "type": "number" + }, + "return_on_assets": { + "description": "Return on assets ratio, calculated as net income divided by total assets, measuring how efficiently a company uses its assets to generate profit.", + "format": "double", + "type": "number" + }, + "return_on_equity": { + "description": "Return on equity ratio, calculated as net income divided by total shareholders' equity, measuring profitability relative to shareholders' equity.", + "format": "double", + "type": "number" + }, + "ticker": { + "description": "Stock ticker symbol for the company.", + "type": "string" } }, "required": [ - "price", - "size" + "ticker", + "date", + "price" ], - "type": "object", - "x-polygon-go-type": { - "name": "Futures" - } + "type": "object" }, "type": "array" }, "status": { "description": "The status of this request's response.", + "enum": [ + "OK" + ], "type": "string" } }, "required": [ - "status" + "status", + "request_id", + "results" ], "type": "object" } } }, - "description": "A list of trades." + "description": "A list of results." + }, + "400": { + "content": { + "application/json": { + "schema": { + "properties": { + "error": { + "description": "A message describing the source of the error.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "ERROR" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "error" + ], + "type": "object" + } + } + }, + "description": "An error message." } }, - "summary": "Trades", "tags": [ "default" + ] + } + }, + "/stocks/v1/exchanges": { + "get": { + "description": "US stock exchanges, trading venues, and reporting facilities including exchanges (NYSE, Nasdaq), Trade Reporting Facilities (TRF), Securities Information Processors (SIP), and OTC Reporting Facilities (ORF) for equity trading.", + "operationId": "get_stocks_v1_exchanges", + "parameters": [ + { + "description": "Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '999'.", + "in": "query", + "name": "limit", + "schema": { + "default": 100, + "maximum": 1000, + "minimum": 1, + "type": "integer" + } + } ], - "x-polygon-entitlement-data-type": { - "description": "Futures trade data", - "name": "trades" - }, - "x-polygon-entitlement-market-type": { - "description": "Futures data", - "name": "futures" - }, - "x-polygon-replaces": { - "date": 1654056060000, - "replaces": { - "name": "Trades", - "path": "get_v1_us_futures_trades__ticker___date" + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "count": 2, + "request_id": 1, + "results": [ + { + "id": "10", + "locale": "US", + "mic": "XNYS", + "name": "New York Stock Exchange", + "operating_mic": "XNYS", + "participant_id": "N", + "type": "exchange", + "url": "https://www.nyse.com" + }, + { + "id": "12", + "locale": "US", + "mic": "XNAS", + "name": "Nasdaq", + "operating_mic": "XNAS", + "participant_id": "T", + "type": "exchange", + "url": "https://www.nasdaq.com" + } + ], + "status": "OK" + }, + "schema": { + "properties": { + "next_url": { + "description": "If present, this value can be used to fetch the next page.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "results": { + "description": "The results for this request.", + "items": { + "properties": { + "acronym": { + "description": "Short acronym or abbreviation (may be null for some venues).", + "type": "string" + }, + "id": { + "description": "Numeric identifier for the trading venue or exchange.", + "type": "string" + }, + "locale": { + "description": "Geographic location code.", + "type": "string" + }, + "mic": { + "description": "Market Identifier Code (MIC) - ISO 10383 standard four-character code for the market (may be empty for some venues).", + "type": "string" + }, + "name": { + "description": "Full official name of the exchange, trading venue, or reporting facility.", + "type": "string" + }, + "operating_mic": { + "description": "Operating Market Identifier Code - identifies the specific operating entity or parent organization.", + "type": "string" + }, + "participant_id": { + "description": "Single-character participant identifier used in market data feeds and trade reporting.", + "type": "string" + }, + "type": { + "description": "Type of trading venue: 'exchange' for stock exchanges, 'TRF' for Trade Reporting Facilities, 'SIP' for Securities Information Processors, 'ORF' for OTC Reporting Facility.", + "type": "string" + }, + "url": { + "description": "Official website URL of the organization operating the venue.", + "type": "string" + } + }, + "required": [ + "id", + "type", + "name" + ], + "type": "object" + }, + "type": "array" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "OK" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "results" + ], + "type": "object" + } + } + }, + "description": "A list of results." + }, + "400": { + "content": { + "application/json": { + "schema": { + "properties": { + "error": { + "description": "A message describing the source of the error.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "status": { + "description": "The status of this request's response.", + "enum": [ + "ERROR" + ], + "type": "string" + } + }, + "required": [ + "status", + "request_id", + "error" + ], + "type": "object" + } + } + }, + "description": "An error message." } - } + }, + "tags": [ + "default" + ] } }, "/stocks/v1/short-interest": { "get": { + "description": "Comprehensive FINRA short interest data that tracks the short selling metrics for securities on a specific settlement date.", "operationId": "get_stocks_v1_short-interest", "parameters": [ { @@ -12105,6 +20930,7 @@ }, "/stocks/v1/short-volume": { "get": { + "description": "Contains short selling volume for different stock tickers, capturing total trading volume, short sale details, and breakdown by different trading platforms.", "operationId": "get_stocks_v1_short-volume", "parameters": [ { @@ -12512,6 +21338,7 @@ }, "/tmx/v1/corporate-events": { "get": { + "description": "Contains corporate events and announcements for publicly traded companies, including earnings releases, conferences, dividends, and business updates sourced from TMX.", "operationId": "get_tmx_v1_corporate-events", "parameters": [ { @@ -12811,14 +21638,6 @@ "type": "integer" } }, - { - "description": "Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer.", - "in": "query", - "name": "tmx_company_id.any_of", - "schema": { - "type": "string" - } - }, { "description": "Filter greater than the value. Value must be an integer.", "in": "query", @@ -13173,7 +21992,7 @@ "type": "number" }, "exchange": { - "description": "The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "timestamp": { @@ -13375,7 +22194,7 @@ "c": { "description": "A list of condition codes.\n", "items": { - "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", + "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", "type": "integer" }, "type": "array" @@ -13399,7 +22218,7 @@ "type": "integer" }, "x": { - "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", + "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", "type": "integer" } }, @@ -13597,7 +22416,7 @@ "type": "integer" }, "x": { - "description": "The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" } }, @@ -13795,11 +22614,11 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/v1/indicators/ema/X:BTCUSD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "next_url": "https://api.massive.com/v1/indicators/ema/X:BTCUSD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3", "results": { "underlying": { - "url": "https://api.polygon.io/v2/aggs/ticker/X:BTCUSD/range/1/day/2003-01-01/2022-07-25" + "url": "https://api.massive.com/v2/aggs/ticker/X:BTCUSD/range/1/day/2003-01-01/2022-07-25" }, "values": [ { @@ -13821,10 +22640,13 @@ "type": "string" }, "results": { + "description": "The results of the EMA indicator calculation.", "properties": { "underlying": { + "description": "The underlying aggregates used.", "properties": { "aggregates": { + "description": "The array of aggregates used in the calculation of this indicator.", "items": { "properties": { "c": { @@ -13897,6 +22719,7 @@ "type": "object" }, "values": { + "description": "Timestamp or indicator value.", "items": { "properties": { "timestamp": { @@ -13909,7 +22732,7 @@ } }, "value": { - "description": "The indicator value for this period.", + "description": "The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -13932,6 +22755,11 @@ "type": "string" } }, + "required": [ + "request_id", + "status", + "results" + ], "type": "object" } }, @@ -14113,11 +22941,11 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/v1/indicators/ema/C:USDAUD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "next_url": "https://api.massive.com/v1/indicators/ema/C:USDAUD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3", "results": { "underlying": { - "url": "https://api.polygon.io/v2/aggs/ticker/C:USDAUD/range/1/day/2003-01-01/2022-07-25" + "url": "https://api.massive.com/v2/aggs/ticker/C:USDAUD/range/1/day/2003-01-01/2022-07-25" }, "values": [ { @@ -14139,10 +22967,13 @@ "type": "string" }, "results": { + "description": "The results of the EMA indicator calculation.", "properties": { "underlying": { + "description": "The underlying aggregates used.", "properties": { "aggregates": { + "description": "The array of aggregates used in the calculation of this indicator.", "items": { "properties": { "c": { @@ -14215,6 +23046,7 @@ "type": "object" }, "values": { + "description": "Timestamp or indicator value.", "items": { "properties": { "timestamp": { @@ -14227,7 +23059,7 @@ } }, "value": { - "description": "The indicator value for this period.", + "description": "The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -14250,6 +23082,11 @@ "type": "string" } }, + "required": [ + "request_id", + "status", + "results" + ], "type": "object" } }, @@ -14431,11 +23268,11 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/v1/indicators/ema/I:NDX?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTE1MDg0Ljk5OTM4OTgyMDAzJTJDJTIyaCUyMiUzQTAlMkMlMjJsJTIyJTNBMCUyQyUyMnQlMjIlM0ExNjg3MjE5MjAwMDAwJTdEJmFzPSZleHBhbmRfdW5kZXJseWluZz1mYWxzZSZsaW1pdD0xJm9yZGVyPWRlc2Mmc2VyaWVzX3R5cGU9Y2xvc2UmdGltZXNwYW49ZGF5JnRpbWVzdGFtcC5sdD0xNjg3MjM3MjAwMDAwJndpbmRvdz01MA", + "next_url": "https://api.massive.com/v1/indicators/ema/I:NDX?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTE1MDg0Ljk5OTM4OTgyMDAzJTJDJTIyaCUyMiUzQTAlMkMlMjJsJTIyJTNBMCUyQyUyMnQlMjIlM0ExNjg3MjE5MjAwMDAwJTdEJmFzPSZleHBhbmRfdW5kZXJseWluZz1mYWxzZSZsaW1pdD0xJm9yZGVyPWRlc2Mmc2VyaWVzX3R5cGU9Y2xvc2UmdGltZXNwYW49ZGF5JnRpbWVzdGFtcC5sdD0xNjg3MjM3MjAwMDAwJndpbmRvdz01MA", "request_id": "b9201816341441eed663a90443c0623a", "results": { "underlying": { - "url": "https://api.polygon.io/v2/aggs/ticker/I:NDX/range/1/day/1678338000000/1687366449650?limit=226&sort=desc" + "url": "https://api.massive.com/v2/aggs/ticker/I:NDX/range/1/day/1678338000000/1687366449650?limit=226&sort=desc" }, "values": [ { @@ -14457,10 +23294,13 @@ "type": "string" }, "results": { + "description": "The results of the EMA indicator calculation.", "properties": { "underlying": { + "description": "The underlying aggregates used.", "properties": { "aggregates": { + "description": "The array of aggregates used in the calculation of this indicator.", "items": { "properties": { "c": { @@ -14533,6 +23373,7 @@ "type": "object" }, "values": { + "description": "Timestamp or indicator value.", "items": { "properties": { "timestamp": { @@ -14545,7 +23386,7 @@ } }, "value": { - "description": "The indicator value for this period.", + "description": "The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -14568,6 +23409,11 @@ "type": "string" } }, + "required": [ + "request_id", + "status", + "results" + ], "type": "object" } } @@ -14744,11 +23590,11 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/v1/indicators/ema/O:SPY241220P00720000?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "next_url": "https://api.massive.com/v1/indicators/ema/O:SPY241220P00720000?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3", "results": { "underlying": { - "url": "https://api.polygon.io/v2/aggs/ticker/O:SPY241220P00720000/range/1/day/2003-01-01/2022-07-25" + "url": "https://api.massive.com/v2/aggs/ticker/O:SPY241220P00720000/range/1/day/2003-01-01/2022-07-25" }, "values": [ { @@ -14770,10 +23616,13 @@ "type": "string" }, "results": { + "description": "The results of the EMA indicator calculation.", "properties": { "underlying": { + "description": "The underlying aggregates used.", "properties": { "aggregates": { + "description": "The array of aggregates used in the calculation of this indicator.", "items": { "properties": { "c": { @@ -14846,6 +23695,7 @@ "type": "object" }, "values": { + "description": "Timestamp or indicator value.", "items": { "properties": { "timestamp": { @@ -14858,7 +23708,7 @@ } }, "value": { - "description": "The indicator value for this period.", + "description": "The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -14881,6 +23731,11 @@ "type": "string" } }, + "required": [ + "request_id", + "status", + "results" + ], "type": "object" } }, @@ -15062,11 +23917,11 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/v1/indicators/ema/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "next_url": "https://api.massive.com/v1/indicators/ema/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3", "results": { "underlying": { - "url": "https://api.polygon.io/v2/aggs/ticker/AAPL/range/1/day/2003-01-01/2022-07-25" + "url": "https://api.massive.com/v2/aggs/ticker/AAPL/range/1/day/2003-01-01/2022-07-25" }, "values": [ { @@ -15088,10 +23943,13 @@ "type": "string" }, "results": { + "description": "The results of the EMA indicator calculation.", "properties": { "underlying": { + "description": "The underlying aggregates used.", "properties": { "aggregates": { + "description": "The array of aggregates used in the calculation of this indicator.", "items": { "properties": { "c": { @@ -15164,6 +24022,7 @@ "type": "object" }, "values": { + "description": "Timestamp or indicator value.", "items": { "properties": { "timestamp": { @@ -15176,7 +24035,7 @@ } }, "value": { - "description": "The indicator value for this period.", + "description": "The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -15199,6 +24058,11 @@ "type": "string" } }, + "required": [ + "request_id", + "status", + "results" + ], "type": "object" } }, @@ -15389,11 +24253,11 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/v1/indicators/macd/X:BTCUSD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "next_url": "https://api.massive.com/v1/indicators/macd/X:BTCUSD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3", "results": { "underlying": { - "url": "https://api.polygon.io/v2/aggs/ticker/X:BTCUSD/range/1/day/2003-01-01/2022-07-25" + "url": "https://api.massive.com/v2/aggs/ticker/X:BTCUSD/range/1/day/2003-01-01/2022-07-25" }, "values": [ { @@ -15423,10 +24287,13 @@ "type": "string" }, "results": { + "description": "The results of the MACD indicator calculation.", "properties": { "underlying": { + "description": "The underlying aggregates used.", "properties": { "aggregates": { + "description": "The array of aggregates used in the calculation of this indicator.", "items": { "properties": { "c": { @@ -15499,10 +24366,11 @@ "type": "object" }, "values": { + "description": "Each entry in the values array represents MACD indicator data for a specific timestamp and includes:", "items": { "properties": { "histogram": { - "description": "The indicator value for this period.", + "description": "The difference between the MACD line (value) and the signal line (signal). Positive histogram values indicate upward (bullish) momentum, while negative histogram values indicate downward (bearish) momentum.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -15510,7 +24378,7 @@ } }, "signal": { - "description": "The indicator value for this period.", + "description": "The signal line value, calculated as the exponential moving average (EMA) of the MACD line (value) over the signal period defined in the request parameters. Traders typically use crossovers between the MACD and signal lines as trading signals.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -15527,7 +24395,7 @@ } }, "value": { - "description": "The indicator value for this period.", + "description": "The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -15550,6 +24418,11 @@ "type": "string" } }, + "required": [ + "request_id", + "status", + "results" + ], "type": "object" } }, @@ -15751,11 +24624,11 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/v1/indicators/macd/C:USDAUD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "next_url": "https://api.massive.com/v1/indicators/macd/C:USDAUD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3", "results": { "underlying": { - "url": "https://api.polygon.io/v2/aggs/ticker/C:USDAUD/range/1/day/2003-01-01/2022-07-25" + "url": "https://api.massive.com/v2/aggs/ticker/C:USDAUD/range/1/day/2003-01-01/2022-07-25" }, "values": [ { @@ -15785,10 +24658,13 @@ "type": "string" }, "results": { + "description": "The results of the MACD indicator calculation.", "properties": { "underlying": { + "description": "The underlying aggregates used.", "properties": { "aggregates": { + "description": "The array of aggregates used in the calculation of this indicator.", "items": { "properties": { "c": { @@ -15861,10 +24737,11 @@ "type": "object" }, "values": { + "description": "Each entry in the values array represents MACD indicator data for a specific timestamp and includes:", "items": { "properties": { "histogram": { - "description": "The indicator value for this period.", + "description": "The difference between the MACD line (value) and the signal line (signal). Positive histogram values indicate upward (bullish) momentum, while negative histogram values indicate downward (bearish) momentum.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -15872,7 +24749,7 @@ } }, "signal": { - "description": "The indicator value for this period.", + "description": "The signal line value, calculated as the exponential moving average (EMA) of the MACD line (value) over the signal period defined in the request parameters. Traders typically use crossovers between the MACD and signal lines as trading signals.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -15889,7 +24766,7 @@ } }, "value": { - "description": "The indicator value for this period.", + "description": "The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -15912,6 +24789,11 @@ "type": "string" } }, + "required": [ + "request_id", + "status", + "results" + ], "type": "object" } }, @@ -16113,11 +24995,11 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/v1/indicators/macd/I:NDX?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTE1MDg0Ljk5OTM4OTgyMDAzJTJDJTIyaCUyMiUzQTAlMkMlMjJsJTIyJTNBMCUyQyUyMnQlMjIlM0ExNjg3MTUwODAwMDAwJTdEJmFzPSZleHBhbmRfdW5kZXJseWluZz1mYWxzZSZsaW1pdD0yJmxvbmdfd2luZG93PTI2Jm9yZGVyPWRlc2Mmc2VyaWVzX3R5cGU9Y2xvc2Umc2hvcnRfd2luZG93PTEyJnNpZ25hbF93aW5kb3c9OSZ0aW1lc3Bhbj1kYXkmdGltZXN0YW1wLmx0PTE2ODcyMTkyMDAwMDA", + "next_url": "https://api.massive.com/v1/indicators/macd/I:NDX?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTE1MDg0Ljk5OTM4OTgyMDAzJTJDJTIyaCUyMiUzQTAlMkMlMjJsJTIyJTNBMCUyQyUyMnQlMjIlM0ExNjg3MTUwODAwMDAwJTdEJmFzPSZleHBhbmRfdW5kZXJseWluZz1mYWxzZSZsaW1pdD0yJmxvbmdfd2luZG93PTI2Jm9yZGVyPWRlc2Mmc2VyaWVzX3R5cGU9Y2xvc2Umc2hvcnRfd2luZG93PTEyJnNpZ25hbF93aW5kb3c9OSZ0aW1lc3Bhbj1kYXkmdGltZXN0YW1wLmx0PTE2ODcyMTkyMDAwMDA", "request_id": "2eeda0be57e83cbc64cc8d1a74e84dbd", "results": { "underlying": { - "url": "https://api.polygon.io/v2/aggs/ticker/I:NDX/range/1/day/1678338000000/1687366537196?limit=121&sort=desc" + "url": "https://api.massive.com/v2/aggs/ticker/I:NDX/range/1/day/1678338000000/1687366537196?limit=121&sort=desc" }, "values": [ { @@ -16147,10 +25029,13 @@ "type": "string" }, "results": { + "description": "The results of the MACD indicator calculation.", "properties": { "underlying": { + "description": "The underlying aggregates used.", "properties": { "aggregates": { + "description": "The array of aggregates used in the calculation of this indicator.", "items": { "properties": { "c": { @@ -16223,10 +25108,11 @@ "type": "object" }, "values": { + "description": "Each entry in the values array represents MACD indicator data for a specific timestamp and includes:", "items": { "properties": { "histogram": { - "description": "The indicator value for this period.", + "description": "The difference between the MACD line (value) and the signal line (signal). Positive histogram values indicate upward (bullish) momentum, while negative histogram values indicate downward (bearish) momentum.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -16234,7 +25120,7 @@ } }, "signal": { - "description": "The indicator value for this period.", + "description": "The signal line value, calculated as the exponential moving average (EMA) of the MACD line (value) over the signal period defined in the request parameters. Traders typically use crossovers between the MACD and signal lines as trading signals.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -16251,7 +25137,7 @@ } }, "value": { - "description": "The indicator value for this period.", + "description": "The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -16274,6 +25160,11 @@ "type": "string" } }, + "required": [ + "request_id", + "status", + "results" + ], "type": "object" } } @@ -16470,11 +25361,11 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/v1/indicators/macd/O:SPY241220P00720000?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "next_url": "https://api.massive.com/v1/indicators/macd/O:SPY241220P00720000?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3", "results": { "underlying": { - "url": "https://api.polygon.io/v2/aggs/ticker/O:SPY241220P00720000/range/1/day/2003-01-01/2022-07-25" + "url": "https://api.massive.com/v2/aggs/ticker/O:SPY241220P00720000/range/1/day/2003-01-01/2022-07-25" }, "values": [ { @@ -16504,10 +25395,13 @@ "type": "string" }, "results": { + "description": "The results of the MACD indicator calculation.", "properties": { "underlying": { + "description": "The underlying aggregates used.", "properties": { "aggregates": { + "description": "The array of aggregates used in the calculation of this indicator.", "items": { "properties": { "c": { @@ -16580,10 +25474,11 @@ "type": "object" }, "values": { + "description": "Each entry in the values array represents MACD indicator data for a specific timestamp and includes:", "items": { "properties": { "histogram": { - "description": "The indicator value for this period.", + "description": "The difference between the MACD line (value) and the signal line (signal). Positive histogram values indicate upward (bullish) momentum, while negative histogram values indicate downward (bearish) momentum.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -16591,7 +25486,7 @@ } }, "signal": { - "description": "The indicator value for this period.", + "description": "The signal line value, calculated as the exponential moving average (EMA) of the MACD line (value) over the signal period defined in the request parameters. Traders typically use crossovers between the MACD and signal lines as trading signals.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -16608,7 +25503,7 @@ } }, "value": { - "description": "The indicator value for this period.", + "description": "The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -16631,6 +25526,11 @@ "type": "string" } }, + "required": [ + "request_id", + "status", + "results" + ], "type": "object" } }, @@ -16832,11 +25732,11 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/v1/indicators/macd/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "next_url": "https://api.massive.com/v1/indicators/macd/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3", "results": { "underlying": { - "url": "https://api.polygon.io/v2/aggs/ticker/AAPL/range/1/day/2003-01-01/2022-07-25" + "url": "https://api.massive.com/v2/aggs/ticker/AAPL/range/1/day/2003-01-01/2022-07-25" }, "values": [ { @@ -16866,10 +25766,13 @@ "type": "string" }, "results": { + "description": "The results of the MACD indicator calculation.", "properties": { "underlying": { + "description": "The underlying aggregates used.", "properties": { "aggregates": { + "description": "The array of aggregates used in the calculation of this indicator.", "items": { "properties": { "c": { @@ -16942,10 +25845,11 @@ "type": "object" }, "values": { + "description": "Each entry in the values array represents MACD indicator data for a specific timestamp and includes:", "items": { "properties": { "histogram": { - "description": "The indicator value for this period.", + "description": "The difference between the MACD line (value) and the signal line (signal). Positive histogram values indicate upward (bullish) momentum, while negative histogram values indicate downward (bearish) momentum.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -16953,7 +25857,7 @@ } }, "signal": { - "description": "The indicator value for this period.", + "description": "The signal line value, calculated as the exponential moving average (EMA) of the MACD line (value) over the signal period defined in the request parameters. Traders typically use crossovers between the MACD and signal lines as trading signals.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -16970,7 +25874,7 @@ } }, "value": { - "description": "The indicator value for this period.", + "description": "The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -16993,6 +25897,11 @@ "type": "string" } }, + "required": [ + "request_id", + "status", + "results" + ], "type": "object" } }, @@ -17163,11 +26072,11 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/v1/indicators/rsi/X:BTCUSD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "next_url": "https://api.massive.com/v1/indicators/rsi/X:BTCUSD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3", "results": { "underlying": { - "url": "https://api.polygon.io/v2/aggs/ticker/X:BTCUSD/range/1/day/2003-01-01/2022-07-25" + "url": "https://api.massive.com/v2/aggs/ticker/X:BTCUSD/range/1/day/2003-01-01/2022-07-25" }, "values": [ { @@ -17189,10 +26098,13 @@ "type": "string" }, "results": { + "description": "The results of the RSI indicator calculation.", "properties": { "underlying": { + "description": "The underlying aggregates used.", "properties": { "aggregates": { + "description": "The array of aggregates used in the calculation of this indicator.", "items": { "properties": { "c": { @@ -17265,6 +26177,7 @@ "type": "object" }, "values": { + "description": "Timestamp or indicator value.", "items": { "properties": { "timestamp": { @@ -17277,7 +26190,7 @@ } }, "value": { - "description": "The indicator value for this period.", + "description": "The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -17300,6 +26213,11 @@ "type": "string" } }, + "required": [ + "request_id", + "status", + "results" + ], "type": "object" } }, @@ -17481,11 +26399,11 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/v1/indicators/rsi/C:USDAUD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "next_url": "https://api.massive.com/v1/indicators/rsi/C:USDAUD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3", "results": { "underlying": { - "url": "https://api.polygon.io/v2/aggs/ticker/C:USDAUD/range/1/day/2003-01-01/2022-07-25" + "url": "https://api.massive.com/v2/aggs/ticker/C:USDAUD/range/1/day/2003-01-01/2022-07-25" }, "values": [ { @@ -17507,10 +26425,13 @@ "type": "string" }, "results": { + "description": "The results of the RSI indicator calculation.", "properties": { "underlying": { + "description": "The underlying aggregates used.", "properties": { "aggregates": { + "description": "The array of aggregates used in the calculation of this indicator.", "items": { "properties": { "c": { @@ -17583,6 +26504,7 @@ "type": "object" }, "values": { + "description": "Timestamp or indicator value.", "items": { "properties": { "timestamp": { @@ -17595,7 +26517,7 @@ } }, "value": { - "description": "The indicator value for this period.", + "description": "The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -17618,6 +26540,11 @@ "type": "string" } }, + "required": [ + "request_id", + "status", + "results" + ], "type": "object" } }, @@ -17799,11 +26726,11 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/v1/indicators/rsi/I:NDX?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTE1MDg0Ljk5OTM4OTgyMDAzJTJDJTIyaCUyMiUzQTAlMkMlMjJsJTIyJTNBMCUyQyUyMnQlMjIlM0ExNjg3MjE5MjAwMDAwJTdEJmFzPSZleHBhbmRfdW5kZXJseWluZz1mYWxzZSZsaW1pdD0xJm9yZGVyPWRlc2Mmc2VyaWVzX3R5cGU9Y2xvc2UmdGltZXNwYW49ZGF5JnRpbWVzdGFtcC5sdD0xNjg3MjM3MjAwMDAwJndpbmRvdz0xNA", + "next_url": "https://api.massive.com/v1/indicators/rsi/I:NDX?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTE1MDg0Ljk5OTM4OTgyMDAzJTJDJTIyaCUyMiUzQTAlMkMlMjJsJTIyJTNBMCUyQyUyMnQlMjIlM0ExNjg3MjE5MjAwMDAwJTdEJmFzPSZleHBhbmRfdW5kZXJseWluZz1mYWxzZSZsaW1pdD0xJm9yZGVyPWRlc2Mmc2VyaWVzX3R5cGU9Y2xvc2UmdGltZXNwYW49ZGF5JnRpbWVzdGFtcC5sdD0xNjg3MjM3MjAwMDAwJndpbmRvdz0xNA", "request_id": "28a8417f521f98e1d08f6ed7d1fbcad3", "results": { "underlying": { - "url": "https://api.polygon.io/v2/aggs/ticker/I:NDX/range/1/day/1678338000000/1687366658253?limit=66&sort=desc" + "url": "https://api.massive.com/v2/aggs/ticker/I:NDX/range/1/day/1678338000000/1687366658253?limit=66&sort=desc" }, "values": [ { @@ -17825,10 +26752,13 @@ "type": "string" }, "results": { + "description": "The results of the RSI indicator calculation.", "properties": { "underlying": { + "description": "The underlying aggregates used.", "properties": { "aggregates": { + "description": "The array of aggregates used in the calculation of this indicator.", "items": { "properties": { "c": { @@ -17901,6 +26831,7 @@ "type": "object" }, "values": { + "description": "Timestamp or indicator value.", "items": { "properties": { "timestamp": { @@ -17913,7 +26844,7 @@ } }, "value": { - "description": "The indicator value for this period.", + "description": "The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -17936,6 +26867,11 @@ "type": "string" } }, + "required": [ + "request_id", + "status", + "results" + ], "type": "object" } } @@ -18112,11 +27048,11 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/v1/indicators/rsi/O:SPY241220P00720000?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "next_url": "https://api.massive.com/v1/indicators/rsi/O:SPY241220P00720000?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3", "results": { "underlying": { - "url": "https://api.polygon.io/v2/aggs/ticker/O:SPY241220P00720000/range/1/day/2003-01-01/2022-07-25" + "url": "https://api.massive.com/v2/aggs/ticker/O:SPY241220P00720000/range/1/day/2003-01-01/2022-07-25" }, "values": [ { @@ -18138,10 +27074,13 @@ "type": "string" }, "results": { + "description": "The results of the RSI indicator calculation.", "properties": { "underlying": { + "description": "The underlying aggregates used.", "properties": { "aggregates": { + "description": "The array of aggregates used in the calculation of this indicator.", "items": { "properties": { "c": { @@ -18214,6 +27153,7 @@ "type": "object" }, "values": { + "description": "Timestamp or indicator value.", "items": { "properties": { "timestamp": { @@ -18226,7 +27166,7 @@ } }, "value": { - "description": "The indicator value for this period.", + "description": "The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -18249,6 +27189,11 @@ "type": "string" } }, + "required": [ + "request_id", + "status", + "results" + ], "type": "object" } }, @@ -18430,11 +27375,11 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/v1/indicators/rsi/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "next_url": "https://api.massive.com/v1/indicators/rsi/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3", "results": { "underlying": { - "url": "https://api.polygon.io/v2/aggs/ticker/AAPL/range/1/day/2003-01-01/2022-07-25" + "url": "https://api.massive.com/v2/aggs/ticker/AAPL/range/1/day/2003-01-01/2022-07-25" }, "values": [ { @@ -18456,10 +27401,13 @@ "type": "string" }, "results": { + "description": "The results of the RSI indicator calculation.", "properties": { "underlying": { + "description": "The underlying aggregates used.", "properties": { "aggregates": { + "description": "The array of aggregates used in the calculation of this indicator.", "items": { "properties": { "c": { @@ -18532,6 +27480,7 @@ "type": "object" }, "values": { + "description": "Timestamp or indicator value.", "items": { "properties": { "timestamp": { @@ -18544,7 +27493,7 @@ } }, "value": { - "description": "The indicator value for this period.", + "description": "The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -18567,6 +27516,11 @@ "type": "string" } }, + "required": [ + "request_id", + "status", + "results" + ], "type": "object" } }, @@ -18737,7 +27691,7 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/v1/indicators/sma/X:BTCUSD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "next_url": "https://api.massive.com/v1/indicators/sma/X:BTCUSD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3", "results": { "underlying": { @@ -18763,7 +27717,7 @@ "vw": 74.7026 } ], - "url": "https://api.polygon.io/v2/aggs/ticker/X:BTCUSD/range/1/day/2003-01-01/2022-07-25" + "url": "https://api.massive.com/v2/aggs/ticker/X:BTCUSD/range/1/day/2003-01-01/2022-07-25" }, "values": [ { @@ -18785,10 +27739,13 @@ "type": "string" }, "results": { + "description": "The results of the SMA indicator calculation.", "properties": { "underlying": { + "description": "The underlying aggregates used.", "properties": { "aggregates": { + "description": "The array of aggregates used in the calculation of this indicator.", "items": { "properties": { "c": { @@ -18861,6 +27818,7 @@ "type": "object" }, "values": { + "description": "Timestamp or indicator value.", "items": { "properties": { "timestamp": { @@ -18873,7 +27831,7 @@ } }, "value": { - "description": "The indicator value for this period.", + "description": "The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -18896,6 +27854,11 @@ "type": "string" } }, + "required": [ + "request_id", + "status", + "results" + ], "type": "object" } }, @@ -19077,7 +28040,7 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/v1/indicators/sma/C:USDAUD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "next_url": "https://api.massive.com/v1/indicators/sma/C:USDAUD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3", "results": { "underlying": { @@ -19103,7 +28066,7 @@ "vw": 74.7026 } ], - "url": "https://api.polygon.io/v2/aggs/ticker/C:USDAUD/range/1/day/2003-01-01/2022-07-25" + "url": "https://api.massive.com/v2/aggs/ticker/C:USDAUD/range/1/day/2003-01-01/2022-07-25" }, "values": [ { @@ -19125,10 +28088,13 @@ "type": "string" }, "results": { + "description": "The results of the SMA indicator calculation.", "properties": { "underlying": { + "description": "The underlying aggregates used.", "properties": { "aggregates": { + "description": "The array of aggregates used in the calculation of this indicator.", "items": { "properties": { "c": { @@ -19201,6 +28167,7 @@ "type": "object" }, "values": { + "description": "Timestamp or indicator value.", "items": { "properties": { "timestamp": { @@ -19213,7 +28180,7 @@ } }, "value": { - "description": "The indicator value for this period.", + "description": "The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -19236,6 +28203,11 @@ "type": "string" } }, + "required": [ + "request_id", + "status", + "results" + ], "type": "object" } }, @@ -19417,11 +28389,11 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/v1/indicators/sma/I:NDX?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTE1MDg0Ljk5OTM4OTgyMDAzJTJDJTIyaCUyMiUzQTAlMkMlMjJsJTIyJTNBMCUyQyUyMnQlMjIlM0ExNjg3MjE5MjAwMDAwJTdEJmFzPSZleHBhbmRfdW5kZXJseWluZz1mYWxzZSZsaW1pdD0xJm9yZGVyPWRlc2Mmc2VyaWVzX3R5cGU9Y2xvc2UmdGltZXNwYW49ZGF5JnRpbWVzdGFtcC5sdD0xNjg3MjM3MjAwMDAwJndpbmRvdz01Mw", + "next_url": "https://api.massive.com/v1/indicators/sma/I:NDX?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTE1MDg0Ljk5OTM4OTgyMDAzJTJDJTIyaCUyMiUzQTAlMkMlMjJsJTIyJTNBMCUyQyUyMnQlMjIlM0ExNjg3MjE5MjAwMDAwJTdEJmFzPSZleHBhbmRfdW5kZXJseWluZz1mYWxzZSZsaW1pdD0xJm9yZGVyPWRlc2Mmc2VyaWVzX3R5cGU9Y2xvc2UmdGltZXNwYW49ZGF5JnRpbWVzdGFtcC5sdD0xNjg3MjM3MjAwMDAwJndpbmRvdz01Mw", "request_id": "4cae270008cb3f947e3f92c206e3888a", "results": { "underlying": { - "url": "https://api.polygon.io/v2/aggs/ticker/I:NDX/range/1/day/1678338000000/1687366378997?limit=240&sort=desc" + "url": "https://api.massive.com/v2/aggs/ticker/I:NDX/range/1/day/1678338000000/1687366378997?limit=240&sort=desc" }, "values": [ { @@ -19443,10 +28415,13 @@ "type": "string" }, "results": { + "description": "The results of the SMA indicator calculation.", "properties": { "underlying": { + "description": "The underlying aggregates used.", "properties": { "aggregates": { + "description": "The array of aggregates used in the calculation of this indicator.", "items": { "properties": { "c": { @@ -19519,6 +28494,7 @@ "type": "object" }, "values": { + "description": "Timestamp or indicator value.", "items": { "properties": { "timestamp": { @@ -19531,7 +28507,7 @@ } }, "value": { - "description": "The indicator value for this period.", + "description": "The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -19554,6 +28530,11 @@ "type": "string" } }, + "required": [ + "request_id", + "status", + "results" + ], "type": "object" } } @@ -19730,7 +28711,7 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/v1/indicators/sma/O:SPY241220P00720000?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "next_url": "https://api.massive.com/v1/indicators/sma/O:SPY241220P00720000?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3", "results": { "underlying": { @@ -19756,7 +28737,7 @@ "vw": 74.7026 } ], - "url": "https://api.polygon.io/v2/aggs/ticker/O:SPY241220P00720000/range/1/day/2003-01-01/2022-07-25" + "url": "https://api.massive.com/v2/aggs/ticker/O:SPY241220P00720000/range/1/day/2003-01-01/2022-07-25" }, "values": [ { @@ -19778,10 +28759,13 @@ "type": "string" }, "results": { + "description": "The results of the SMA indicator calculation.", "properties": { "underlying": { + "description": "The underlying aggregates used.", "properties": { "aggregates": { + "description": "The array of aggregates used in the calculation of this indicator.", "items": { "properties": { "c": { @@ -19854,6 +28838,7 @@ "type": "object" }, "values": { + "description": "Timestamp or indicator value.", "items": { "properties": { "timestamp": { @@ -19866,7 +28851,7 @@ } }, "value": { - "description": "The indicator value for this period.", + "description": "The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -19889,6 +28874,11 @@ "type": "string" } }, + "required": [ + "request_id", + "status", + "results" + ], "type": "object" } }, @@ -20070,7 +29060,7 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/v1/indicators/sma/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "next_url": "https://api.massive.com/v1/indicators/sma/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3", "results": { "underlying": { @@ -20096,7 +29086,7 @@ "vw": 74.7026 } ], - "url": "https://api.polygon.io/v2/aggs/ticker/AAPL/range/1/day/2003-01-01/2022-07-25" + "url": "https://api.massive.com/v2/aggs/ticker/AAPL/range/1/day/2003-01-01/2022-07-25" }, "values": [ { @@ -20118,10 +29108,13 @@ "type": "string" }, "results": { + "description": "The results of the SMA indicator calculation.", "properties": { "underlying": { + "description": "The underlying aggregates used.", "properties": { "aggregates": { + "description": "The array of aggregates used in the calculation of this indicator.", "items": { "properties": { "c": { @@ -20194,6 +29187,7 @@ "type": "object" }, "values": { + "description": "Timestamp or indicator value.", "items": { "properties": { "timestamp": { @@ -20206,7 +29200,7 @@ } }, "value": { - "description": "The indicator value for this period.", + "description": "The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters.", "format": "float", "type": "number", "x-polygon-go-type": { @@ -20229,6 +29223,11 @@ "type": "string" } }, + "required": [ + "request_id", + "status", + "results" + ], "type": "object" } }, @@ -20308,7 +29307,7 @@ "conditions": { "description": "A list of condition codes.", "items": { - "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/stocks/get_v3_reference_conditions)\nfor a mapping to exchange conditions.", + "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/stocks/get_v3_reference_conditions)\nfor a mapping to exchange conditions.", "format": "int32", "type": "integer" }, @@ -20318,7 +29317,7 @@ } }, "exchange": { - "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.", + "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.", "type": "integer" }, "price": { @@ -20456,7 +29455,7 @@ "type": "number" }, "exchange": { - "description": "The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "timestamp": { @@ -20640,7 +29639,7 @@ "type": "string" }, "s_and_p": { - "description": "The status of Standard & Poors's (\"S&P\") indices trading hours.", + "description": "The status of Standard & Poor's (\"S&P\") indices trading hours.", "type": "string" }, "societe_generale": { @@ -20888,7 +29887,7 @@ "c": { "description": "A list of condition codes.\n", "items": { - "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", + "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", "type": "integer" }, "type": "array" @@ -20912,7 +29911,7 @@ "type": "integer" }, "x": { - "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", + "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", "type": "integer" } }, @@ -20949,7 +29948,7 @@ "c": { "description": "A list of condition codes.\n", "items": { - "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", + "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", "type": "integer" }, "type": "array" @@ -20973,7 +29972,7 @@ "type": "integer" }, "x": { - "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", + "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", "type": "integer" } }, @@ -21566,7 +30565,7 @@ "operationId": "GetSnapshotSummary", "parameters": [ { - "description": "Comma separated list of tickers. This API currently supports Stocks/Equities, Crypto, Options, and Forex. See the tickers endpoint for more details on supported tickers. If no tickers are passed then no results will be returned.\n\nWarning: The maximum number of characters allowed in a URL are subject to your technology stack.", + "description": "Comma separated list of tickers. This API currently supports Stocks/Equities, Crypto, Options, and Forex. See the tickers endpoint for more details on supported tickers. If no tickers are passed then no results will be returned.\n\nWarning: The maximum number of characters allowed in a URL are subject to your technology stack.", "example": "NCLH,O:SPY250321C00380000,C:EURUSD,X:BTCUSD", "in": "query", "name": "ticker.any_of", @@ -21584,8 +30583,8 @@ "results": [ { "branding": { - "icon_url": "https://api.polygon.io/icon.png", - "logo_url": "https://api.polygon.io/logo.svg" + "icon_url": "https://api.massive.com/icon.png", + "logo_url": "https://api.massive.com/logo.svg" }, "last_updated": 1679597116344223500, "market_status": "closed", @@ -21657,8 +30656,8 @@ }, { "branding": { - "icon_url": "https://api.polygon.io/icon.png", - "logo_url": "https://api.polygon.io/logo.svg" + "icon_url": "https://api.massive.com/icon.png", + "logo_url": "https://api.massive.com/logo.svg" }, "last_updated": 1679597116344223500, "market_status": "open", @@ -22843,7 +31842,7 @@ } }, { - "description": "Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000.\nRead more about how limit is used to calculate aggregate results in our article on\nAggregate Data API Improvements.\n", + "description": "Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000.\nRead more about how limit is used to calculate aggregate results in our article on\nAggregate Data API Improvements.\n", "example": 120, "in": "query", "name": "limit", @@ -23300,7 +32299,7 @@ } }, { - "description": "Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000.\nRead more about how limit is used to calculate aggregate results in our article on\nAggregate Data API Improvements.\n", + "description": "Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000.\nRead more about how limit is used to calculate aggregate results in our article on\nAggregate Data API Improvements.\n", "example": 120, "in": "query", "name": "limit", @@ -23701,7 +32700,7 @@ } }, { - "description": "Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000.\nRead more about how limit is used to calculate aggregate results in our article on\nAggregate Data API Improvements.\n", + "description": "Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000.\nRead more about how limit is used to calculate aggregate results in our article on\nAggregate Data API Improvements.\n", "example": 120, "in": "query", "name": "limit", @@ -24127,7 +33126,7 @@ } }, { - "description": "Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000.\nRead more about how limit is used to calculate aggregate results in our article on\nAggregate Data API Improvements.\n", + "description": "Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000.\nRead more about how limit is used to calculate aggregate results in our article on\nAggregate Data API Improvements.\n", "example": 120, "in": "query", "name": "limit", @@ -24579,7 +33578,7 @@ } }, { - "description": "Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000.\nRead more about how limit is used to calculate aggregate results in our article on\nAggregate Data API Improvements.\n", + "description": "Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000.\nRead more about how limit is used to calculate aggregate results in our article on\nAggregate Data API Improvements.\n", "example": 120, "in": "query", "name": "limit", @@ -24594,7 +33593,7 @@ "application/json": { "example": { "adjusted": true, - "next_url": "https://api.polygon.io/v2/aggs/ticker/AAPL/range/1/day/1578114000000/2020-01-10?cursor=bGltaXQ9MiZzb3J0PWFzYw", + "next_url": "https://api.massive.com/v2/aggs/ticker/AAPL/range/1/day/1578114000000/2020-01-10?cursor=bGltaXQ9MiZzb3J0PWFzYw", "queryCount": 2, "request_id": "6a7e466379af0a71039d60cc78e72282", "results": [ @@ -24824,7 +33823,7 @@ "type": "number" }, "S": { - "description": "The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price.", + "description": "The total number of shares available for sale at the current ask price.", "type": "integer" }, "T": { @@ -24832,13 +33831,13 @@ "type": "string" }, "X": { - "description": "The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "c": { "description": "A list of condition codes.", "items": { - "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/stocks/get_v3_reference_conditions)\nfor a mapping to exchange conditions.", + "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/stocks/get_v3_reference_conditions)\nfor a mapping to exchange conditions.", "format": "int32", "type": "integer" }, @@ -24854,7 +33853,7 @@ "i": { "description": "A list of indicator codes.", "items": { - "description": "The indicator codes. For more information, see our glossary of [Conditions and\nIndicators](https://polygon.io/glossary/us/stocks/conditions-indicators).", + "description": "The indicator codes. For more information, see our glossary of [Conditions and\nIndicators](https://massive.com/glossary/us/stocks/conditions-indicators).", "format": "int32", "type": "integer" }, @@ -24874,7 +33873,7 @@ "type": "integer" }, "s": { - "description": "The bid size. This represents the number of round lot orders at the given bid price. The normal round lot size is 100 shares. A bid size of 2 means there are 200 shares for purchase at the given bid price.", + "description": "The total number of shares that buyers want to purchase at the current bid price.", "type": "integer" }, "t": { @@ -24882,7 +33881,7 @@ "type": "integer" }, "x": { - "description": "The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "y": { @@ -25011,7 +34010,7 @@ "c": { "description": "A list of condition codes.", "items": { - "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/stocks/get_v3_reference_conditions)\nfor a mapping to exchange conditions.", + "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/stocks/get_v3_reference_conditions)\nfor a mapping to exchange conditions.", "format": "int32", "type": "integer" }, @@ -25056,7 +34055,7 @@ "type": "integer" }, "x": { - "description": "The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "y": { @@ -25191,7 +34190,7 @@ "c": { "description": "A list of condition codes.", "items": { - "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/stocks/get_v3_reference_conditions)\nfor a mapping to exchange conditions.", + "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/stocks/get_v3_reference_conditions)\nfor a mapping to exchange conditions.", "format": "int32", "type": "integer" }, @@ -25236,7 +34235,7 @@ "type": "integer" }, "x": { - "description": "The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "y": { @@ -25500,7 +34499,7 @@ "application/json": { "example": { "count": 1, - "next_url": "https://api.polygon.io:443/v2/reference/news?cursor=eyJsaW1pdCI6MSwic29ydCI6InB1Ymxpc2hlZF91dGMiLCJvcmRlciI6ImFzY2VuZGluZyIsInRpY2tlciI6e30sInB1Ymxpc2hlZF91dGMiOnsiZ3RlIjoiMjAyMS0wNC0yNiJ9LCJzZWFyY2hfYWZ0ZXIiOlsxNjE5NDA0Mzk3MDAwLG51bGxdfQ", + "next_url": "https://api.massive.com:443/v2/reference/news?cursor=eyJsaW1pdCI6MSwic29ydCI6InB1Ymxpc2hlZF91dGMiLCJvcmRlciI6ImFzY2VuZGluZyIsInRpY2tlciI6e30sInB1Ymxpc2hlZF91dGMiOnsiZ3RlIjoiMjAyMS0wNC0yNiJ9LCJzZWFyY2hfYWZ0ZXIiOlsxNjE5NDA0Mzk3MDAwLG51bGxdfQ", "request_id": "831afdb0b8078549fed053476984947a", "results": [ { @@ -25524,9 +34523,9 @@ ], "published_utc": "2024-06-24T18:33:53Z", "publisher": { - "favicon_url": "https://s3.polygon.io/public/assets/news/favicons/investing.ico", + "favicon_url": "https://s3.massive.com/public/assets/news/favicons/investing.ico", "homepage_url": "https://www.investing.com/", - "logo_url": "https://s3.polygon.io/public/assets/news/logos/investing.png", + "logo_url": "https://s3.massive.com/public/assets/news/logos/investing.png", "name": "Investing.com" }, "tickers": [ @@ -25691,7 +34690,7 @@ } }, "text/csv": { - "example": "id,publisher_name,publisher_homepage_url,publisher_logo_url,publisher_favicon_url,title,author,published_utc,article_url,ticker,amp_url,image_url,description,keywords,sentiment,sentiment_reasoning\n8ec638777ca03b553ae516761c2a22ba2fdd2f37befae3ab6fdab74e9e5193eb,Investing.com,https://www.investing.com/,https://s3.polygon.io/public/assets/news/logos/investing.png,https://s3.polygon.io/public/assets/news/favicons/investing.ico,Markets are underestimating Fed cuts: UBS By Investing.com - Investing.com UK,Sam Boughedda,1719254033000000000,https://uk.investing.com/news/stock-market-news/markets-are-underestimating-fed-cuts-ubs-3559968,UBS,https://m.uk.investing.com/news/stock-market-news/markets-are-underestimating-fed-cuts-ubs-3559968?ampMode=1,https://i-invdn-com.investing.com/news/LYNXNPEC4I0AL_L.jpg,\"UBS analysts warn that markets are underestimating the extent of future interest rate cuts by the Federal Reserve, as the weakening economy is likely to justify more cuts than currently anticipated.\",\"Federal Reserve,interest rates,economic data\",positive,\"UBS analysts are providing a bullish outlook on the extent of future Federal Reserve rate cuts, suggesting that markets are underestimating the number of cuts that will occur.\"\n", + "example": "id,publisher_name,publisher_homepage_url,publisher_logo_url,publisher_favicon_url,title,author,published_utc,article_url,ticker,amp_url,image_url,description,keywords,sentiment,sentiment_reasoning\n8ec638777ca03b553ae516761c2a22ba2fdd2f37befae3ab6fdab74e9e5193eb,Investing.com,https://www.investing.com/,https://s3.massive.com/public/assets/news/logos/investing.png,https://s3.massive.com/public/assets/news/favicons/investing.ico,Markets are underestimating Fed cuts: UBS By Investing.com - Investing.com UK,Sam Boughedda,1719254033000000000,https://uk.investing.com/news/stock-market-news/markets-are-underestimating-fed-cuts-ubs-3559968,UBS,https://m.uk.investing.com/news/stock-market-news/markets-are-underestimating-fed-cuts-ubs-3559968?ampMode=1,https://i-invdn-com.investing.com/news/LYNXNPEC4I0AL_L.jpg,\"UBS analysts warn that markets are underestimating the extent of future interest rate cuts by the Federal Reserve, as the weakening economy is likely to justify more cuts than currently anticipated.\",\"Federal Reserve,interest rates,economic data\",positive,\"UBS analysts are providing a bullish outlook on the extent of future Federal Reserve rate cuts, suggesting that markets are underestimating the number of cuts that will occur.\"\n", "schema": { "type": "string" } @@ -25865,7 +34864,7 @@ "type": "object" }, "fmv": { - "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", + "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", "format": "double", "type": "number" }, @@ -25897,7 +34896,7 @@ "type": "integer" }, "x": { - "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", + "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", "type": "integer" } }, @@ -26227,7 +35226,7 @@ "type": "object" }, "fmv": { - "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", + "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", "format": "double", "type": "number" }, @@ -26259,7 +35258,7 @@ "type": "integer" }, "x": { - "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", + "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", "type": "integer" } }, @@ -26765,7 +35764,7 @@ "type": "object" }, "fmv": { - "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", + "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", "format": "double", "type": "number" }, @@ -26797,7 +35796,7 @@ "type": "integer" }, "x": { - "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", + "description": "The exchange that this crypto trade happened on. \nSee Exchanges for a mapping of exchanges to IDs.\n", "type": "integer" } }, @@ -27106,7 +36105,7 @@ "type": "object" }, "fmv": { - "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", + "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", "format": "double", "type": "number" }, @@ -27430,7 +36429,7 @@ "type": "object" }, "fmv": { - "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", + "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", "format": "double", "type": "number" }, @@ -27745,7 +36744,7 @@ "type": "object" }, "fmv": { - "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", + "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", "format": "double", "type": "number" }, @@ -28099,7 +37098,7 @@ "type": "object" }, "fmv": { - "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", + "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", "format": "double", "type": "number" }, @@ -28166,7 +37165,7 @@ "type": "integer" }, "x": { - "description": "The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" } }, @@ -28512,7 +37511,7 @@ "type": "object" }, "fmv": { - "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", + "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", "format": "double", "type": "number" }, @@ -28579,7 +37578,7 @@ "type": "integer" }, "x": { - "description": "The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" } }, @@ -28924,7 +37923,7 @@ "type": "object" }, "fmv": { - "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", + "description": "Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us.", "format": "double", "type": "number" }, @@ -28991,7 +37990,7 @@ "type": "integer" }, "x": { - "description": "The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" } }, @@ -29412,19 +38411,19 @@ "type": "integer" }, "X": { - "description": "The ask exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The ask exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "c": { "description": "A list of condition codes.\n", "items": { - "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", + "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", "type": "integer" }, "type": "array" }, "i": { - "description": "The indicators. For more information, see our glossary of [Conditions and\nIndicators](https://polygon.io/glossary/us/stocks/conditions-indicators).\n", + "description": "The indicators. For more information, see our glossary of [Conditions and\nIndicators](https://massive.com/glossary/us/stocks/conditions-indicators).\n", "items": { "description": "The indicator code.\n", "type": "integer" @@ -29441,7 +38440,7 @@ "type": "integer" }, "x": { - "description": "The bid exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The bid exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "z": { @@ -29721,7 +38720,7 @@ "c": { "description": "A list of condition codes.\n", "items": { - "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", + "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n", "type": "integer" }, "type": "array" @@ -29749,7 +38748,7 @@ "type": "number" }, "x": { - "description": "The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "z": { @@ -29910,7 +38909,7 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/v3/quotes/C:EUR-USD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "next_url": "https://api.massive.com/v3/quotes/C:EUR-USD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3", "results": [ { @@ -30142,7 +39141,7 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/v3/quotes/O:SPY241220P00720000?cursor=YXA9NzY5Nzg0NzAxJmFzPSZsaW1pdD0xMCZvcmRlcj1kZXNjJnNvcnQ9dGltZXN0YW1wJnRpbWVzdGFtcC5sdGU9MjAyMi0wMi0xN1QxNyUzQTI1JTNBMTMuMDA5MzU2MDMyWg", + "next_url": "https://api.massive.com/v3/quotes/O:SPY241220P00720000?cursor=YXA9NzY5Nzg0NzAxJmFzPSZsaW1pdD0xMCZvcmRlcj1kZXNjJnNvcnQ9dGltZXN0YW1wJnRpbWVzdGFtcC5sdGU9MjAyMi0wMi0xN1QxNyUzQTI1JTNBMTMuMDA5MzU2MDMyWg", "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3", "results": [ { @@ -30210,267 +39209,267 @@ "format": "double", "type": "number" }, - "sequence_number": { - "description": "The sequence number represents the sequence in which quote events happened.\nThese are increasing and unique per ticker symbol, but will not always be\nsequential (e.g., 1, 2, 6, 9, 10, 11).", - "format": "int64", - "type": "integer" - }, - "sip_timestamp": { - "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it.", - "format": "int64", - "type": "integer", - "x-polygon-go-type": { - "name": "INanoseconds", - "path": "github.com/polygon-io/ptime" - } - } - }, - "required": [ - "sip_timestamp", - "sequence_number" - ], - "type": "object" - }, - "type": "array" - }, - "status": { - "description": "The status of this request's response.", - "type": "string" - } - }, - "required": [ - "status" - ], - "type": "object" - } - }, - "text/csv": { - "example": "ask_exchange,ask_price,ask_size,bid_exchange,bid_price,bid_size,sequence_number,sip_timestamp\n323,282,10,316,277.5,1,789539218,1645119125346243600\n301,282,1,323,277.5,10,788994206,1645119118474271000\n", - "schema": { - "type": "string" - } - } - }, - "description": "A list of quotes." - } - }, - "summary": "Quotes", - "tags": [ - "default" - ], - "x-polygon-entitlement-data-type": { - "description": "NBBO data", - "name": "nbbo" - }, - "x-polygon-entitlement-market-type": { - "description": "Options data", - "name": "options" - }, - "x-polygon-paginate": { - "limit": { - "default": 1000, - "example": 10, - "max": 50000 - }, - "order": { - "default": "desc" - }, - "sort": { - "default": "timestamp", - "enum": [ - "timestamp" - ] - } - } - }, - "x-polygon-ignore": true - }, - "/v3/quotes/{stockTicker}": { - "get": { - "description": "Get NBBO quotes for a ticker symbol in a given time range.", - "operationId": "GetStocksQuotes", - "parameters": [ - { - "description": "Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc.", - "example": "AAPL", - "in": "path", - "name": "stockTicker", - "required": true, - "schema": { - "type": "string" - }, - "x-polygon-go-id": "Ticker" - }, - { - "description": "Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp.", - "in": "query", - "name": "timestamp", - "schema": { - "type": "string" - }, - "x-polygon-filter-field": { - "range": true - } - }, - { - "description": "Range by timestamp.", - "in": "query", - "name": "timestamp.gte", - "schema": { - "type": "string" - } - }, - { - "description": "Range by timestamp.", - "in": "query", - "name": "timestamp.gt", - "schema": { - "type": "string" - } - }, - { - "description": "Range by timestamp.", - "in": "query", - "name": "timestamp.lte", - "schema": { - "type": "string" - } - }, - { - "description": "Range by timestamp.", - "in": "query", - "name": "timestamp.lt", - "schema": { - "type": "string" - } - }, - { - "description": "Order results based on the `sort` field.", - "in": "query", - "name": "order", - "schema": { - "default": "desc", - "enum": [ - "asc", - "desc" - ], - "example": "asc", - "type": "string" - } - }, - { - "description": "Limit the number of results returned, default is 1000 and max is 50000.", - "in": "query", - "name": "limit", - "schema": { - "default": 1000, - "example": 10, - "maximum": 50000, - "minimum": 1, - "type": "integer" - } - }, - { - "description": "Sort field used for ordering.", - "in": "query", - "name": "sort", - "schema": { - "default": "timestamp", - "enum": [ - "timestamp" - ], - "example": "timestamp", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "example": { - "next_url": "https://api.polygon.io/v3/quotes/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", - "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3", - "results": [ - { - "ask_exchange": 0, - "ask_price": 0, - "ask_size": 0, - "bid_exchange": 11, - "bid_price": 102.7, - "bid_size": 60, - "conditions": [ - 1 - ], - "participant_timestamp": 1517562000065321200, - "sequence_number": 2060, - "sip_timestamp": 1517562000065700400, - "tape": 3 - }, - { - "ask_exchange": 0, - "ask_price": 0, - "ask_size": 0, - "bid_exchange": 11, - "bid_price": 170, - "bid_size": 2, - "conditions": [ - 1 - ], - "participant_timestamp": 1517562000065408300, - "sequence_number": 2061, - "sip_timestamp": 1517562000065791500, - "tape": 3 - } - ], - "status": "OK" - }, - "schema": { - "properties": { - "next_url": { - "description": "If present, this value can be used to fetch the next page of data.", - "type": "string" - }, - "request_id": { - "description": "A request id assigned by the server.", - "type": "string" - }, - "results": { - "description": "An array of results containing the requested data.", - "items": { - "properties": { - "ask_exchange": { - "description": "The ask exchange ID", - "type": "integer" - }, - "ask_price": { - "description": "The ask price.", - "format": "double", - "type": "number" - }, - "ask_size": { - "description": "The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price.", - "format": "double", - "type": "number" - }, - "bid_exchange": { - "description": "The bid exchange ID", - "type": "integer" - }, - "bid_price": { - "description": "The bid price.", - "format": "double", - "type": "number" - }, - "bid_size": { - "description": "The bid size. This represents the number of round lot orders at the given bid price. The normal round lot size is 100 shares. A bid size of 2 means there are 200 shares for purchase at the given bid price.", - "format": "double", - "type": "number" - }, + "sequence_number": { + "description": "The sequence number represents the sequence in which quote events happened.\nThese are increasing and unique per ticker symbol, but will not always be\nsequential (e.g., 1, 2, 6, 9, 10, 11).", + "format": "int64", + "type": "integer" + }, + "sip_timestamp": { + "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it.", + "format": "int64", + "type": "integer", + "x-polygon-go-type": { + "name": "INanoseconds", + "path": "github.com/polygon-io/ptime" + } + } + }, + "required": [ + "sip_timestamp", + "sequence_number" + ], + "type": "object" + }, + "type": "array" + }, + "status": { + "description": "The status of this request's response.", + "type": "string" + } + }, + "required": [ + "status" + ], + "type": "object" + } + }, + "text/csv": { + "example": "ask_exchange,ask_price,ask_size,bid_exchange,bid_price,bid_size,sequence_number,sip_timestamp\n323,282,10,316,277.5,1,789539218,1645119125346243600\n301,282,1,323,277.5,10,788994206,1645119118474271000\n", + "schema": { + "type": "string" + } + } + }, + "description": "A list of quotes." + } + }, + "summary": "Quotes", + "tags": [ + "default" + ], + "x-polygon-entitlement-data-type": { + "description": "NBBO data", + "name": "nbbo" + }, + "x-polygon-entitlement-market-type": { + "description": "Options data", + "name": "options" + }, + "x-polygon-paginate": { + "limit": { + "default": 1000, + "example": 10, + "max": 50000 + }, + "order": { + "default": "desc" + }, + "sort": { + "default": "timestamp", + "enum": [ + "timestamp" + ] + } + } + }, + "x-polygon-ignore": true + }, + "/v3/quotes/{stockTicker}": { + "get": { + "description": "Get NBBO quotes for a ticker symbol in a given time range.", + "operationId": "GetStocksQuotes", + "parameters": [ + { + "description": "Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc.", + "example": "AAPL", + "in": "path", + "name": "stockTicker", + "required": true, + "schema": { + "type": "string" + }, + "x-polygon-go-id": "Ticker" + }, + { + "description": "Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp.", + "in": "query", + "name": "timestamp", + "schema": { + "type": "string" + }, + "x-polygon-filter-field": { + "range": true + } + }, + { + "description": "Range by timestamp.", + "in": "query", + "name": "timestamp.gte", + "schema": { + "type": "string" + } + }, + { + "description": "Range by timestamp.", + "in": "query", + "name": "timestamp.gt", + "schema": { + "type": "string" + } + }, + { + "description": "Range by timestamp.", + "in": "query", + "name": "timestamp.lte", + "schema": { + "type": "string" + } + }, + { + "description": "Range by timestamp.", + "in": "query", + "name": "timestamp.lt", + "schema": { + "type": "string" + } + }, + { + "description": "Order results based on the `sort` field.", + "in": "query", + "name": "order", + "schema": { + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "example": "asc", + "type": "string" + } + }, + { + "description": "Limit the number of results returned, default is 1000 and max is 50000.", + "in": "query", + "name": "limit", + "schema": { + "default": 1000, + "example": 10, + "maximum": 50000, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "Sort field used for ordering.", + "in": "query", + "name": "sort", + "schema": { + "default": "timestamp", + "enum": [ + "timestamp" + ], + "example": "timestamp", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "example": { + "next_url": "https://api.massive.com/v3/quotes/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3", + "results": [ + { + "ask_exchange": 0, + "ask_price": 0, + "ask_size": 0, + "bid_exchange": 11, + "bid_price": 102.7, + "bid_size": 60, + "conditions": [ + 1 + ], + "participant_timestamp": 1517562000065321200, + "sequence_number": 2060, + "sip_timestamp": 1517562000065700400, + "tape": 3 + }, + { + "ask_exchange": 0, + "ask_price": 0, + "ask_size": 0, + "bid_exchange": 11, + "bid_price": 170, + "bid_size": 2, + "conditions": [ + 1 + ], + "participant_timestamp": 1517562000065408300, + "sequence_number": 2061, + "sip_timestamp": 1517562000065791500, + "tape": 3 + } + ], + "status": "OK" + }, + "schema": { + "properties": { + "next_url": { + "description": "If present, this value can be used to fetch the next page of data.", + "type": "string" + }, + "request_id": { + "description": "A request id assigned by the server.", + "type": "string" + }, + "results": { + "description": "An array of results containing the requested data.", + "items": { + "properties": { + "ask_exchange": { + "description": "The ask exchange ID", + "type": "integer" + }, + "ask_price": { + "description": "The ask price.", + "format": "double", + "type": "number" + }, + "ask_size": { + "description": "The total number of shares available for sale at the current ask price.", + "format": "double", + "type": "number" + }, + "bid_exchange": { + "description": "The bid exchange ID", + "type": "integer" + }, + "bid_price": { + "description": "The bid price.", + "format": "double", + "type": "number" + }, + "bid_size": { + "description": "The total number of shares that buyers want to purchase at the current bid price.", + "format": "double", + "type": "number" + }, "conditions": { "description": "A list of condition codes.", "items": { - "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/stocks/get_v3_reference_conditions)\nfor a mapping to exchange conditions.", + "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/stocks/get_v3_reference_conditions)\nfor a mapping to exchange conditions.", "format": "int32", "type": "integer" }, @@ -30482,7 +39481,7 @@ "indicators": { "description": "A list of indicator codes.", "items": { - "description": "The indicator codes. For more information, see our glossary of [Conditions and\nIndicators](https://polygon.io/glossary/us/stocks/conditions-indicators).", + "description": "The indicator codes. For more information, see our glossary of [Conditions and\nIndicators](https://massive.com/glossary/us/stocks/conditions-indicators).", "format": "int32", "type": "integer" }, @@ -30601,7 +39600,7 @@ }, "/v3/reference/conditions": { "get": { - "description": "List all conditions that Polygon.io uses.", + "description": "List all conditions that Massive.com uses.", "operationId": "ListConditions", "parameters": [ { @@ -30639,7 +39638,7 @@ "in": "query", "name": "id", "schema": { - "description": "An identifier used by Polygon.io for this condition. Unique per data type.", + "description": "An identifier used by Massive.com for this condition. Unique per data type.", "type": "integer" } }, @@ -30791,11 +39790,11 @@ "type": "string" }, "exchange": { - "description": "If present, mapping this condition from a Polygon.io code to a SIP symbol depends on this attribute.\nIn other words, data with this condition attached comes exclusively from the given exchange.", + "description": "If present, mapping this condition from a Massive.com code to a SIP symbol depends on this attribute.\nIn other words, data with this condition attached comes exclusively from the given exchange.", "type": "integer" }, "id": { - "description": "An identifier used by Polygon.io for this condition. Unique per data type.", + "description": "An identifier used by Massive.com for this condition. Unique per data type.", "type": "integer" }, "legacy": { @@ -30808,7 +39807,7 @@ "type": "string" }, "sip_mapping": { - "description": "A comprehensive mapping that translates condition codes from individual SIPs (CTA, OPRA, UTP) to a unified code used by Polygon.io. This facilitates consistent interpretation and application of market data conditions across different data streams, ensuring that users can accurately apply these conditions to their data analysis and reporting.", + "description": "A comprehensive mapping that translates condition codes from individual SIPs (CTA, OPRA, UTP) to a unified code used by Massive.com. This facilitates consistent interpretation and application of market data conditions across different data streams, ensuring that users can accurately apply these conditions to their data analysis and reporting.", "properties": { "CTA": { "description": "Condition code from the Consolidated Tape Association (CTA).", @@ -30989,11 +39988,11 @@ "type": "string" }, "exchange": { - "description": "If present, mapping this condition from a Polygon.io code to a SIP symbol depends on this attribute.\nIn other words, data with this condition attached comes exclusively from the given exchange.", + "description": "If present, mapping this condition from a Massive.com code to a SIP symbol depends on this attribute.\nIn other words, data with this condition attached comes exclusively from the given exchange.", "type": "integer" }, "id": { - "description": "An identifier used by Polygon.io for this condition. Unique per data type.", + "description": "An identifier used by Massive.com for this condition. Unique per data type.", "type": "integer" }, "legacy": { @@ -31006,7 +40005,7 @@ "type": "string" }, "sip_mapping": { - "description": "A comprehensive mapping that translates condition codes from individual SIPs (CTA, OPRA, UTP) to a unified code used by Polygon.io. This facilitates consistent interpretation and application of market data conditions across different data streams, ensuring that users can accurately apply these conditions to their data analysis and reporting.", + "description": "A comprehensive mapping that translates condition codes from individual SIPs (CTA, OPRA, UTP) to a unified code used by Massive.com. This facilitates consistent interpretation and application of market data conditions across different data streams, ensuring that users can accurately apply these conditions to their data analysis and reporting.", "properties": { "CTA": { "description": "Condition code from the Consolidated Tape Association (CTA).", @@ -31181,11 +40180,11 @@ "type": "string" }, "exchange": { - "description": "If present, mapping this condition from a Polygon.io code to a SIP symbol depends on this attribute.\nIn other words, data with this condition attached comes exclusively from the given exchange.", + "description": "If present, mapping this condition from a Massive.com code to a SIP symbol depends on this attribute.\nIn other words, data with this condition attached comes exclusively from the given exchange.", "type": "integer" }, "id": { - "description": "An identifier used by Polygon.io for this condition. Unique per data type.", + "description": "An identifier used by Massive.com for this condition. Unique per data type.", "type": "integer" }, "legacy": { @@ -31198,7 +40197,7 @@ "type": "string" }, "sip_mapping": { - "description": "A comprehensive mapping that translates condition codes from individual SIPs (CTA, OPRA, UTP) to a unified code used by Polygon.io. This facilitates consistent interpretation and application of market data conditions across different data streams, ensuring that users can accurately apply these conditions to their data analysis and reporting.", + "description": "A comprehensive mapping that translates condition codes from individual SIPs (CTA, OPRA, UTP) to a unified code used by Massive.com. This facilitates consistent interpretation and application of market data conditions across different data streams, ensuring that users can accurately apply these conditions to their data analysis and reporting.", "properties": { "CTA": { "description": "Condition code from the Consolidated Tape Association (CTA).", @@ -31716,7 +40715,7 @@ "schema": { "description": "A list of dividends.", "example": { - "next_url": "https://api.polygon.io/v3/reference/dividends/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "next_url": "https://api.massive.com/v3/reference/dividends/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", "request_id": "6a7e466379af0a71039d60cc78e72282", "results": [ { @@ -31874,7 +40873,7 @@ }, "/v3/reference/exchanges": { "get": { - "description": "List all exchanges that Polygon.io knows about.", + "description": "List all exchanges that Massive.com knows about.", "operationId": "ListExchanges", "parameters": [ { @@ -31948,7 +40947,7 @@ "type": "string" }, "id": { - "description": "A unique identifier used by Polygon.io for this exchange.", + "description": "A unique identifier used by Massive.com for this exchange.", "example": 1, "type": "integer" }, @@ -32121,7 +41120,7 @@ } }, { - "description": "This parameter has been deprecated. To search by specific options ticker, use the Options Contract endpoint [here](https://polygon.io/docs/options/get_v3_reference_options_contracts__options_ticker).", + "description": "This parameter has been deprecated. To search by specific options ticker, use the Options Contract endpoint [here](https://massive.com/docs/options/get_v3_reference_options_contracts__options_ticker).", "in": "query", "name": "ticker", "schema": { @@ -32509,7 +41508,7 @@ "operationId": "GetOptionsContract", "parameters": [ { - "description": "Query for a contract by options ticker. You can learn more about the structure of options tickers [here](https://polygon.io/blog/how-to-read-a-stock-options-ticker/).", + "description": "Query for a contract by options ticker. You can learn more about the structure of options tickers [here](https://massive.com/blog/how-to-read-a-stock-options-ticker/).", "example": "O:SPY251219C00650000", "in": "path", "name": "options_ticker", @@ -32829,7 +41828,7 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/v3/splits/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "next_url": "https://api.massive.com/v3/splits/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", "request_id": "6a7e466379af0a71039d60cc78e72282", "results": [ { @@ -32940,7 +41939,7 @@ }, "/v3/reference/tickers": { "get": { - "description": "Query all ticker symbols which are supported by Polygon.io. This API currently includes Stocks/Equities, Indices, Forex, and Crypto.", + "description": "Query all ticker symbols which are supported by Massive.com. This API currently includes Stocks/Equities, Indices, Forex, and Crypto.", "operationId": "ListTickers", "parameters": [ { @@ -32955,7 +41954,7 @@ } }, { - "description": "Specify the type of the tickers. Find the types that we support via our [Ticker Types API](https://polygon.io/docs/stocks/get_v3_reference_tickers_types).\nDefaults to empty string which queries all types.", + "description": "Specify the type of the tickers. Find the types that we support via our [Ticker Types API](https://massive.com/docs/stocks/get_v3_reference_tickers_types).\nDefaults to empty string which queries all types.", "in": "query", "name": "type", "schema": { @@ -33143,7 +42142,7 @@ "application/json": { "example": { "count": 1, - "next_url": "https://api.polygon.io/v3/reference/tickers?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "next_url": "https://api.massive.com/v3/reference/tickers?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", "request_id": "e70013d92930de90e089dc8fa098888e", "results": [ { @@ -33185,6 +42184,14 @@ "description": "Whether or not the asset is actively traded. False means the asset has been delisted.", "type": "boolean" }, + "base_currency_name": { + "description": "The name of the currency that this asset is priced against.", + "type": "string" + }, + "base_currency_symbol": { + "description": "The ISO 4217 code of the currency that this asset is priced against.", + "type": "string" + }, "cik": { "description": "The CIK number for this ticker. Find more information [here](https://en.wikipedia.org/wiki/Central_Index_Key).", "type": "string" @@ -33197,6 +42204,10 @@ "description": "The name of the currency that this asset is traded with.", "type": "string" }, + "currency_symbol": { + "description": "The ISO 4217 code of the currency that this asset is traded with.", + "type": "string" + }, "delisted_utc": { "description": "The last date that the asset was traded.", "format": "date-time", @@ -33231,7 +42242,7 @@ "type": "string" }, "primary_exchange": { - "description": "The Market Identifier Code (MIC) of the primary listing exchange for this asset (see [ISO 10383](https://www.iso20022.org/market-identifier-codes)).", + "description": "The ISO code of the primary listing exchange for this asset.", "type": "string" }, "share_class_figi": { @@ -33243,7 +42254,7 @@ "type": "string" }, "type": { - "description": "The type of the asset. Find the types that we support via our [Ticker Types API](https://polygon.io/docs/stocks/get_v3_reference_tickers_types).", + "description": "The type of the asset. Find the types that we support via our [Ticker Types API](https://massive.com/docs/stocks/get_v3_reference_tickers_types).", "type": "string" } }, @@ -33320,7 +42331,7 @@ }, "/v3/reference/tickers/types": { "get": { - "description": "List all ticker types that Polygon.io has.", + "description": "List all ticker types that Massive.com has.", "operationId": "ListTickerTypes", "parameters": [ { @@ -33388,7 +42399,7 @@ "type": "string" }, "code": { - "description": "A code used by Polygon.io to refer to this ticker type.", + "description": "A code used by Massive.com to refer to this ticker type.", "example": "CS", "type": "string" }, @@ -33514,7 +42525,7 @@ }, "/v3/reference/tickers/{ticker}": { "get": { - "description": "Get a single ticker supported by Polygon.io. This response will have detailed information about the ticker and the company behind it.", + "description": "Get a single ticker supported by Massive.com. This response will have detailed information about the ticker and the company behind it.", "operationId": "GetTicker", "parameters": [ { @@ -33552,8 +42563,8 @@ "state": "CA" }, "branding": { - "icon_url": "https://api.polygon.io/v1/reference/company-branding/d3d3LmFwcGxlLmNvbQ/images/2022-01-10_icon.png", - "logo_url": "https://api.polygon.io/v1/reference/company-branding/d3d3LmFwcGxlLmNvbQ/images/2022-01-10_logo.svg" + "icon_url": "https://api.massive.com/v1/reference/company-branding/d3d3LmFwcGxlLmNvbQ/images/2022-01-10_icon.png", + "logo_url": "https://api.massive.com/v1/reference/company-branding/d3d3LmFwcGxlLmNvbQ/images/2022-01-10_logo.svg" }, "cik": "0000320193", "composite_figi": "BBG000B9XRY4", @@ -33699,7 +42710,7 @@ "type": "string" }, "primary_exchange": { - "description": "The Market Identifier Code (MIC) of the primary listing exchange for this asset (see [ISO 10383](https://www.iso20022.org/market-identifier-codes)).", + "description": "The ISO code of the primary listing exchange for this asset.", "type": "string" }, "round_lot": { @@ -33741,7 +42752,7 @@ "type": "number" }, "type": { - "description": "The type of the asset. Find the types that we support via our [Ticker Types API](https://polygon.io/docs/stocks/get_v3_reference_tickers_types).", + "description": "The type of the asset. Find the types that we support via our [Ticker Types API](https://massive.com/docs/stocks/get_v3_reference_tickers_types).", "type": "string" }, "weighted_shares_outstanding": { @@ -33773,7 +42784,7 @@ } }, "text/csv": { - "example": "ticker,name,market,locale,primary_exchange,type,active,currency_name,cik,composite_figi,share_class_figi,share_class_shares_outstanding,weighted_shares_outstanding,round_lot,market_cap,phone_number,address1,address2,city,state,postal_code,sic_code,sic_description,ticker_root,total_employees,list_date,homepage_url,description,branding/logo_url,branding/icon_url\nAAPL,Apple Inc.,stocks,us,XNAS,CS,true,usd,0000320193,BBG000B9XRY4,BBG001S5N8V8,16406400000,16334371000,100,2771126040150,(408) 996-1010,One Apple Park Way,,Cupertino,CA,95014,3571,ELECTRONIC COMPUTERS,AAPL,154000,1980-12-12,https://www.apple.com,\"Apple designs a wide variety of consumer electronic devices, including smartphones (iPhone), tablets (iPad), PCs (Mac), smartwatches (Apple Watch), AirPods, and TV boxes (Apple TV), among others. The iPhone makes up the majority of Apple's total revenue. In addition, Apple offers its customers a variety of services such as Apple Music, iCloud, Apple Care, Apple TV+, Apple Arcade, Apple Card, and Apple Pay, among others. Apple's products run internally developed software and semiconductors, and the firm is well known for its integration of hardware, software and services. Apple's products are distributed online as well as through company-owned stores and third-party retailers. The company generates roughly 40% of its revenue from the Americas, with the remainder earned internationally.\",https://api.polygon.io/v1/reference/company-branding/d3d3LmFwcGxlLmNvbQ/images/2022-01-10_logo.svg,https://api.polygon.io/v1/reference/company-branding/d3d3LmFwcGxlLmNvbQ/images/2022-01-10_icon.png\n", + "example": "ticker,name,market,locale,primary_exchange,type,active,currency_name,cik,composite_figi,share_class_figi,share_class_shares_outstanding,weighted_shares_outstanding,round_lot,market_cap,phone_number,address1,address2,city,state,postal_code,sic_code,sic_description,ticker_root,total_employees,list_date,homepage_url,description,branding/logo_url,branding/icon_url\nAAPL,Apple Inc.,stocks,us,XNAS,CS,true,usd,0000320193,BBG000B9XRY4,BBG001S5N8V8,16406400000,16334371000,100,2771126040150,(408) 996-1010,One Apple Park Way,,Cupertino,CA,95014,3571,ELECTRONIC COMPUTERS,AAPL,154000,1980-12-12,https://www.apple.com,\"Apple designs a wide variety of consumer electronic devices, including smartphones (iPhone), tablets (iPad), PCs (Mac), smartwatches (Apple Watch), AirPods, and TV boxes (Apple TV), among others. The iPhone makes up the majority of Apple's total revenue. In addition, Apple offers its customers a variety of services such as Apple Music, iCloud, Apple Care, Apple TV+, Apple Arcade, Apple Card, and Apple Pay, among others. Apple's products run internally developed software and semiconductors, and the firm is well known for its integration of hardware, software and services. Apple's products are distributed online as well as through company-owned stores and third-party retailers. The company generates roughly 40% of its revenue from the Americas, with the remainder earned internationally.\",https://api.massive.com/v1/reference/company-branding/d3d3LmFwcGxlLmNvbQ/images/2022-01-10_logo.svg,https://api.massive.com/v1/reference/company-branding/d3d3LmFwcGxlLmNvbQ/images/2022-01-10_icon.png\n", "schema": { "type": "string" } @@ -33930,6 +42941,7 @@ "underlying_ticker": "NCLH" }, "fmv": 0.05, + "fmv_last_updated": 1636573458757383400, "greeks": { "delta": 0.5520187372272933, "gamma": 0.00706756515659829, @@ -33989,6 +43001,7 @@ }, { "fmv": 0.05, + "fmv_last_updated": 1636573458757383400, "last_minute": { "close": 412.05, "high": 412.1, @@ -34119,11 +43132,20 @@ "type": "string" }, "fmv": { - "description": "Fair market value is only available on Business plans. It's it our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security.\nFor more information, contact us.", + "description": "Fair Market Value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security.\nFor more information, contact us.", "type": "number" }, + "fmv_last_updated": { + "description": "If Fair Market Value (FMV) is available, this field is the nanosecond timestamp of the last FMV calculation.", + "format": "int64", + "type": "integer", + "x-polygon-go-type": { + "name": "INanoseconds", + "path": "github.com/polygon-io/ptime" + } + }, "greeks": { - "description": "The greeks for this contract.\nThere are certain circumstances where greeks will not be returned, such as options contracts that are deep in the money.\nSee this article for more information.", + "description": "The greeks for this contract.\nThere are certain circumstances where greeks will not be returned, such as options contracts that are deep in the money.\nSee this article for more information.", "properties": { "delta": { "description": "The change in the option's price per $0.01 increment in the price of the underlying asset.", @@ -34225,7 +43247,7 @@ "type": "number" }, "ask_exchange": { - "description": "The ask side exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The ask side exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "ask_size": { @@ -34239,7 +43261,7 @@ "type": "number" }, "bid_exchange": { - "description": "The bid side exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The bid side exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "bid_size": { @@ -34287,14 +43309,14 @@ "conditions": { "description": "A list of condition codes.", "items": { - "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/stocks/get_v3_reference_conditions)\nfor a mapping to exchange conditions.", + "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/stocks/get_v3_reference_conditions)\nfor a mapping to exchange conditions.", "format": "int32", "type": "integer" }, "type": "array" }, "exchange": { - "description": "The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "id": { @@ -35096,6 +44118,7 @@ "ticker": "O:AAPL211022C000150000" }, "fmv": 0.05, + "fmv_last_updated": 1605195918508251600, "greeks": { "delta": 1, "gamma": 0, @@ -35287,11 +44310,20 @@ } }, "fmv": { - "description": "Fair market value is only available on Business plans. It's it our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security.\nFor more information, contact us.", + "description": "Fair Market Value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security.\nFor more information, contact us.", "type": "number" }, + "fmv_last_updated": { + "description": "If Fair Market Value (FMV) is available, this field is the nanosecond timestamp of the last FMV calculation.", + "format": "int64", + "type": "integer", + "x-polygon-go-type": { + "name": "INanoseconds", + "path": "github.com/polygon-io/ptime" + } + }, "greeks": { - "description": "The greeks for this contract.\nThere are certain circumstances where greeks will not be returned, such as options contracts that are deep in the money.\nSee this article for more information.", + "description": "The greeks for this contract.\nThere are certain circumstances where greeks will not be returned, such as options contracts that are deep in the money.\nSee this article for more information.", "properties": { "delta": { "description": "The change in the option's price per $0.01 increment in the price of the underlying asset.", @@ -35339,7 +44371,7 @@ "type": "number" }, "ask_exchange": { - "description": "The ask side exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The ask side exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "format": "int32", "type": "number" }, @@ -35354,7 +44386,7 @@ "type": "number" }, "bid_exchange": { - "description": "The bid side exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The bid side exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "format": "int32", "type": "number" }, @@ -35404,14 +44436,14 @@ "conditions": { "description": "A list of condition codes.", "items": { - "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/options/get_v3_reference_conditions)\nfor a mapping to exchange conditions.", + "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/options/get_v3_reference_conditions)\nfor a mapping to exchange conditions.", "format": "int32", "type": "integer" }, "type": "array" }, "exchange": { - "description": "The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "price": { @@ -35628,6 +44660,7 @@ "ticker": "O:AAPL230616C00150000" }, "fmv": 0.05, + "fmv_last_updated": 1636573458757383400, "greeks": { "delta": 0.5520187372272933, "gamma": 0.00706756515659829, @@ -35818,11 +44851,20 @@ } }, "fmv": { - "description": "Fair market value is only available on Business plans. It's it our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security.\nFor more information, contact us.", + "description": "Fair Market Value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security.\nFor more information, contact us.", "type": "number" }, + "fmv_last_updated": { + "description": "If Fair Market Value (FMV) is available, this field is the nanosecond timestamp of the last FMV calculation.", + "format": "int64", + "type": "integer", + "x-polygon-go-type": { + "name": "INanoseconds", + "path": "github.com/polygon-io/ptime" + } + }, "greeks": { - "description": "The greeks for this contract.\nThere are certain circumstances where greeks will not be returned, such as options contracts that are deep in the money.\nSee this article for more information.", + "description": "The greeks for this contract.\nThere are certain circumstances where greeks will not be returned, such as options contracts that are deep in the money.\nSee this article for more information.", "properties": { "delta": { "description": "The change in the option's price per $0.01 increment in the price of the underlying asset.", @@ -35870,7 +44912,7 @@ "type": "number" }, "ask_exchange": { - "description": "The ask side exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The ask side exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "format": "int32", "type": "number" }, @@ -35885,7 +44927,7 @@ "type": "number" }, "bid_exchange": { - "description": "The bid side exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The bid side exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "format": "int32", "type": "number" }, @@ -35935,14 +44977,14 @@ "conditions": { "description": "A list of condition codes.", "items": { - "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/options/get_v3_reference_conditions)\nfor a mapping to exchange conditions.", + "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/options/get_v3_reference_conditions)\nfor a mapping to exchange conditions.", "format": "int32", "type": "integer" }, "type": "array" }, "exchange": { - "description": "The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "price": { @@ -36197,7 +45239,7 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/v3/trades/X:BTC-USD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "next_url": "https://api.massive.com/v3/trades/X:BTC-USD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3", "results": [ { @@ -36240,7 +45282,7 @@ "conditions": { "description": "A list of condition codes.", "items": { - "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/stocks/get_v3_reference_conditions)\nfor a mapping to exchange conditions.", + "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/stocks/get_v3_reference_conditions)\nfor a mapping to exchange conditions.", "format": "int32", "type": "integer" }, @@ -36250,7 +45292,7 @@ } }, "exchange": { - "description": "The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "id": { @@ -36449,7 +45491,7 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/v3/trades/O:AZO140621P00530000?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "next_url": "https://api.massive.com/v3/trades/O:AZO140621P00530000?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3", "results": [ { @@ -36489,7 +45531,7 @@ "conditions": { "description": "A list of condition codes.", "items": { - "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/stocks/get_v3_reference_conditions)\nfor a mapping to exchange conditions.", + "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/stocks/get_v3_reference_conditions)\nfor a mapping to exchange conditions.", "format": "int32", "type": "integer" }, @@ -36503,7 +45545,7 @@ "type": "integer" }, "exchange": { - "description": "The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "participant_timestamp": { @@ -36701,7 +45743,7 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/v3/trades/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "next_url": "https://api.massive.com/v3/trades/AAPL?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3", "results": [ { @@ -36752,7 +45794,7 @@ "conditions": { "description": "A list of condition codes.", "items": { - "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/stocks/get_v3_reference_conditions)\nfor a mapping to exchange conditions.", + "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://massive.com/docs/stocks/get_v3_reference_conditions)\nfor a mapping to exchange conditions.", "format": "int32", "type": "integer" }, @@ -36766,7 +45808,7 @@ "type": "integer" }, "exchange": { - "description": "The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.", + "description": "The exchange ID. See Exchanges for Massive.com's mapping of exchange IDs.", "type": "integer" }, "id": { @@ -37111,7 +46153,7 @@ "application/json": { "example": { "count": 1, - "next_url": "https://api.polygon.io/vX/reference/financials?", + "next_url": "https://api.massive.com/vX/reference/financials?", "request_id": "55eb92ed43b25568ab0cce159830ea34", "results": [ { @@ -37389,8 +46431,8 @@ }, "fiscal_period": "Q1", "fiscal_year": "2022", - "source_filing_file_url": "https://api.polygon.io/v1/reference/sec/filings/0001650729-22-000010/files/site-20220403_htm.xml", - "source_filing_url": "https://api.polygon.io/v1/reference/sec/filings/0001650729-22-000010", + "source_filing_file_url": "https://api.massive.com/v1/reference/sec/filings/0001650729-22-000010/files/site-20220403_htm.xml", + "source_filing_url": "https://api.massive.com/v1/reference/sec/filings/0001650729-22-000010", "start_date": "2022-01-03" } ], @@ -37438,7 +46480,7 @@ "description": "Structured financial statements with detailed data points and metadata.", "properties": { "balance_sheet": { - "description": "Balance sheet.\nThe keys in this object can be any of the fields listed in the Balance Sheet section of the financials API glossary of terms.", + "description": "Balance sheet.\nThe keys in this object can be any of the fields listed in the Balance Sheet section of the financials API glossary of terms.", "properties": { "*": { "description": "An individual financial data point.", @@ -37491,15 +46533,15 @@ "type": "object" }, "cash_flow_statement": { - "description": "Cash flow statement.\nThe keys in this object can be any of the fields listed in the Cash Flow Statement section of the financials API glossary of terms.\nSee the attributes of the objects within `balance_sheet` for more details.", + "description": "Cash flow statement.\nThe keys in this object can be any of the fields listed in the Cash Flow Statement section of the financials API glossary of terms.\nSee the attributes of the objects within `balance_sheet` for more details.", "type": "object" }, "comprehensive_income": { - "description": "Comprehensive income.\nThe keys in this object can be any of the fields listed in the Comprehensive Income section of the financials API glossary of terms.\nSee the attributes of the objects within `balance_sheet` for more details.", + "description": "Comprehensive income.\nThe keys in this object can be any of the fields listed in the Comprehensive Income section of the financials API glossary of terms.\nSee the attributes of the objects within `balance_sheet` for more details.", "type": "object" }, "income_statement": { - "description": "Income statement.\nThe keys in this object can be any of the fields listed in the Income Statement section of the financials API glossary of terms.\nSee the attributes of the objects within `balance_sheet` for more details.", + "description": "Income statement.\nThe keys in this object can be any of the fields listed in the Income Statement section of the financials API glossary of terms.\nSee the attributes of the objects within `balance_sheet` for more details.", "type": "object" } }, @@ -37756,7 +46798,7 @@ "content": { "application/json": { "example": { - "next_url": "https://api.polygon.io/vX/reference/ipos?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", + "next_url": "https://api.massive.com/vX/reference/ipos?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy", "request_id": "6a7e466379af0a71039d60cc78e72282", "results": [ { @@ -37994,7 +47036,7 @@ "operationId": "GetEvents", "parameters": [ { - "description": "Identifier of an asset, which can be a Ticker, CUSIP, or Composite FIGI. Specify a case-sensitive\nticker symbol (e.g. AAPL for Apple Inc). When provided a ticker, events for the entity currently\nrepresented by that ticker are returned. To find events for entities previously associated with a\nticker, obtain the relevant identifier using the [Ticker Details Endpoint](https://polygon.io/docs/stocks/get_v3_reference_tickers__ticker).", + "description": "Identifier of an asset, which can be a Ticker, CUSIP, or Composite FIGI. Specify a case-sensitive \nticker symbol (e.g. AAPL for Apple Inc). When provided a ticker, events for the entity currently \nrepresented by that ticker are returned. To find events for entities previously associated with a \nticker, obtain the relevant identifier using the [Ticker Details Endpoint](https://massive.com/docs/stocks/get_v3_reference_tickers__ticker).", "example": "META", "in": "path", "name": "id", @@ -38128,12 +47170,12 @@ ], "servers": [ { - "description": "Polygon Platform API", - "url": "https://api.polygon.io" + "description": "Massive Platform API", + "url": "https://api.massive.com" }, { - "description": "Polygon Platform API (Staging)", - "url": "https://api.staging.polygon.io" + "description": "Massive Platform API (Staging)", + "url": "https://api.staging.massive.com" } ], "tags": [ diff --git a/src/rest/.openapi-generator/FILES b/src/rest/.openapi-generator/FILES index 50b7e6f..a95b2b7 100644 --- a/src/rest/.openapi-generator/FILES +++ b/src/rest/.openapi-generator/FILES @@ -62,6 +62,8 @@ docs/GetBenzingaV1News200Response.md docs/GetBenzingaV1News200ResponseResultsInner.md docs/GetBenzingaV1Ratings200Response.md docs/GetBenzingaV1Ratings200ResponseResultsInner.md +docs/GetBenzingaV2News200Response.md +docs/GetBenzingaV2News200ResponseResultsInner.md docs/GetCryptoAggregates200Response.md docs/GetCryptoAggregates200ResponseAllOfResultsInner.md docs/GetCryptoEMA200Response.md @@ -88,8 +90,21 @@ docs/GetCryptoSnapshotTickers200ResponseAllOfTickersInnerMin.md docs/GetCryptoSnapshotTickers200ResponseAllOfTickersInnerPrevDay.md docs/GetCryptoTrades200Response.md docs/GetCryptoTrades200ResponseResultsInner.md +docs/GetCryptoV1Exchanges200Response.md +docs/GetCryptoV1Exchanges200ResponseResultsInner.md docs/GetCurrencyConversion200Response.md docs/GetCurrencyConversion200ResponseLast.md +docs/GetEtfGlobalV1Analytics200Response.md +docs/GetEtfGlobalV1Analytics200ResponseResultsInner.md +docs/GetEtfGlobalV1Constituents200Response.md +docs/GetEtfGlobalV1Constituents200ResponseResultsInner.md +docs/GetEtfGlobalV1FundFlows200Response.md +docs/GetEtfGlobalV1FundFlows200ResponseResultsInner.md +docs/GetEtfGlobalV1Profiles200Response.md +docs/GetEtfGlobalV1Profiles200ResponseResultsInner.md +docs/GetEtfGlobalV1Profiles200ResponseResultsInnerCouponExposureInner.md +docs/GetEtfGlobalV1Taxonomies200Response.md +docs/GetEtfGlobalV1Taxonomies200ResponseResultsInner.md docs/GetEvents200Response.md docs/GetEvents200ResponseResults.md docs/GetEvents200ResponseResultsEventsInner.md @@ -110,6 +125,8 @@ docs/GetForexSnapshotTickers200ResponseAllOfTickersInner.md docs/GetForexSnapshotTickers200ResponseAllOfTickersInnerDay.md docs/GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote.md docs/GetForexSnapshotTickers200ResponseAllOfTickersInnerMin.md +docs/GetForexV1Exchanges200Response.md +docs/GetForexV1Exchanges200ResponseResultsInner.md docs/GetFuturesAggregates200Response.md docs/GetFuturesAggregates200ResponseResultsInner.md docs/GetFuturesContractDetails200Response.md @@ -128,6 +145,19 @@ docs/GetFuturesQuotes200Response.md docs/GetFuturesQuotes200ResponseResultsInner.md docs/GetFuturesTrades200Response.md docs/GetFuturesTrades200ResponseResultsInner.md +docs/GetFuturesVXContractsNew200Response.md +docs/GetFuturesVXContractsNew200ResponseResultsInner.md +docs/GetFuturesVXExchanges200Response.md +docs/GetFuturesVXExchanges200ResponseResultsInner.md +docs/GetFuturesVXProductsNew200Response.md +docs/GetFuturesVXProductsNew200ResponseResultsInner.md +docs/GetFuturesVXSnapshot200Response.md +docs/GetFuturesVXSnapshot200ResponseResultsInner.md +docs/GetFuturesVXSnapshot200ResponseResultsInnerDetails.md +docs/GetFuturesVXSnapshot200ResponseResultsInnerLastMinute.md +docs/GetFuturesVXSnapshot200ResponseResultsInnerLastQuote.md +docs/GetFuturesVXSnapshot200ResponseResultsInnerLastTrade.md +docs/GetFuturesVXSnapshot200ResponseResultsInnerSession.md docs/GetGroupedCryptoAggregates200Response.md docs/GetGroupedCryptoAggregates200ResponseAllOfResultsInner.md docs/GetGroupedStocksAggregates200Response.md @@ -161,6 +191,8 @@ docs/GetOptionsQuotes200Response.md docs/GetOptionsQuotes200ResponseResultsInner.md docs/GetOptionsTrades200Response.md docs/GetOptionsTrades200ResponseResultsInner.md +docs/GetOptionsV1Exchanges200Response.md +docs/GetOptionsV1Exchanges200ResponseResultsInner.md docs/GetPreviousCryptoAggregates200Response.md docs/GetPreviousForexAggregates200Response.md docs/GetPreviousForexAggregates200ResponseAllOfResultsInner.md @@ -183,6 +215,14 @@ docs/GetSnapshots200ResponseResultsInnerLastTrade.md docs/GetSnapshots200ResponseResultsInnerUnderlyingAsset.md docs/GetStocksAggregates200Response.md docs/GetStocksAggregates200ResponseAllOfResultsInner.md +docs/GetStocksFinancialsV1BalanceSheets200Response.md +docs/GetStocksFinancialsV1BalanceSheets200ResponseResultsInner.md +docs/GetStocksFinancialsV1CashFlowStatements200Response.md +docs/GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner.md +docs/GetStocksFinancialsV1IncomeStatements200Response.md +docs/GetStocksFinancialsV1IncomeStatements200ResponseResultsInner.md +docs/GetStocksFinancialsV1Ratios200Response.md +docs/GetStocksFinancialsV1Ratios200ResponseResultsInner.md docs/GetStocksQuotes200Response.md docs/GetStocksQuotes200ResponseResultsInner.md docs/GetStocksSnapshotDirection200Response.md @@ -197,6 +237,8 @@ docs/GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin.md docs/GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay.md docs/GetStocksTrades200Response.md docs/GetStocksTrades200ResponseResultsInner.md +docs/GetStocksV1Exchanges200Response.md +docs/GetStocksV1Exchanges200ResponseResultsInner.md docs/GetStocksV1ShortInterest200Response.md docs/GetStocksV1ShortInterest200ResponseResultsInner.md docs/GetStocksV1ShortVolume200Response.md diff --git a/src/rest/api.ts b/src/rest/api.ts index 41e9403..2e3aae9 100644 --- a/src/rest/api.ts +++ b/src/rest/api.ts @@ -180,7 +180,7 @@ export interface Company { */ 'tags'?: Array; /** - * The type or class of the security. (Full List of Ticker Types) + * The type or class of the security. (Full List of Ticker Types) * @type {string} * @memberof Company */ @@ -205,7 +205,7 @@ export interface Company { */ export interface ConditionTypeMap { /** - * Polygon.io\'s mapping for condition codes. For more information, see our Trade Conditions Glossary. + * Massive.com\'s mapping for condition codes. For more information, see our Trade Conditions Glossary. * @type {string} * @memberof ConditionTypeMap */ @@ -218,7 +218,7 @@ export interface ConditionTypeMap { */ export interface CryptoExchangeInner { /** - * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. + * The exchange ID. See Exchanges for Massive.com\'s mapping of exchange IDs. * @type {number} * @memberof CryptoExchangeInner */ @@ -330,7 +330,7 @@ export interface CryptoLastTradeLast { */ 'conditions': Array; /** - * The exchange that this crypto trade happened on. See Exchanges for a mapping of exchanges to IDs. + * The exchange that this crypto trade happened on. See Exchanges for a mapping of exchanges to IDs. * @type {number} * @memberof CryptoLastTradeLast */ @@ -534,7 +534,7 @@ export interface CryptoTick { */ 't': number; /** - * The exchange that this crypto trade happened on. See Exchanges for a mapping of exchanges to IDs. + * The exchange that this crypto trade happened on. See Exchanges for a mapping of exchanges to IDs. * @type {number} * @memberof CryptoTick */ @@ -695,7 +695,7 @@ export interface DeprecatedGetHistoricCryptoTrades200ResponseAllOfTicksInner { */ 't': number; /** - * The exchange that this crypto trade happened on. See Exchanges for a mapping of exchanges to IDs. + * The exchange that this crypto trade happened on. See Exchanges for a mapping of exchanges to IDs. * @type {number} * @memberof DeprecatedGetHistoricCryptoTrades200ResponseAllOfTicksInner */ @@ -769,7 +769,7 @@ export interface DeprecatedGetHistoricForexQuotes200ResponseAllOfTicksInner { */ 't': number; /** - * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. + * The exchange ID. See Exchanges for Massive.com\'s mapping of exchange IDs. * @type {number} * @memberof DeprecatedGetHistoricForexQuotes200ResponseAllOfTicksInner */ @@ -861,7 +861,7 @@ export interface DeprecatedGetHistoricStocksQuotes200ResponseAllOfResultsInner { */ 'S': number; /** - * The ask exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. + * The ask exchange ID. See Exchanges for Massive.com\'s mapping of exchange IDs. * @type {number} * @memberof DeprecatedGetHistoricStocksQuotes200ResponseAllOfResultsInner */ @@ -873,7 +873,7 @@ export interface DeprecatedGetHistoricStocksQuotes200ResponseAllOfResultsInner { */ 'c': Array; /** - * The indicators. For more information, see our glossary of [Conditions and Indicators](https://polygon.io/glossary/us/stocks/conditions-indicators). + * The indicators. For more information, see our glossary of [Conditions and Indicators](https://massive.com/glossary/us/stocks/conditions-indicators). * @type {Array} * @memberof DeprecatedGetHistoricStocksQuotes200ResponseAllOfResultsInner */ @@ -891,7 +891,7 @@ export interface DeprecatedGetHistoricStocksQuotes200ResponseAllOfResultsInner { */ 's': number; /** - * The bid exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. + * The bid exchange ID. See Exchanges for Massive.com\'s mapping of exchange IDs. * @type {number} * @memberof DeprecatedGetHistoricStocksQuotes200ResponseAllOfResultsInner */ @@ -1013,7 +1013,7 @@ export interface DeprecatedGetHistoricStocksTrades200ResponseAllOfResultsInner { */ 's': number; /** - * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. + * The exchange ID. See Exchanges for Massive.com\'s mapping of exchange IDs. * @type {number} * @memberof DeprecatedGetHistoricStocksTrades200ResponseAllOfResultsInner */ @@ -1032,7 +1032,7 @@ export interface DeprecatedGetHistoricStocksTrades200ResponseAllOfResultsInner { */ export interface ExchangeInner { /** - * A unique identifier for the exchange internal to Polygon.io. This is not an industry code or ISO standard. + * A unique identifier for the exchange internal to Massive.com. This is not an industry code or ISO standard. * @type {string} * @memberof ExchangeInner */ @@ -1950,7 +1950,7 @@ export interface ForexConversionLast { */ 'bid': number; /** - * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. + * The exchange ID. See Exchanges for Massive.com\'s mapping of exchange IDs. * @type {number} * @memberof ForexConversionLast */ @@ -3317,6 +3317,125 @@ export interface GetBenzingaV1Ratings200ResponseResultsInner { */ 'time'?: string; } +/** + * + * @export + * @interface GetBenzingaV2News200Response + */ +export interface GetBenzingaV2News200Response { + /** + * If present, this value can be used to fetch the next page. + * @type {string} + * @memberof GetBenzingaV2News200Response + */ + 'next_url'?: string; + /** + * A request id assigned by the server. + * @type {string} + * @memberof GetBenzingaV2News200Response + */ + 'request_id': string; + /** + * The results for this request. + * @type {Array} + * @memberof GetBenzingaV2News200Response + */ + 'results': Array; + /** + * The status of this request\'s response. + * @type {string} + * @memberof GetBenzingaV2News200Response + */ + 'status': GetBenzingaV2News200ResponseStatusEnum; +} + +/** + * @export + * @enum {string} + */ +export enum GetBenzingaV2News200ResponseStatusEnum { + Ok = 'OK' +} + +/** + * + * @export + * @interface GetBenzingaV2News200ResponseResultsInner + */ +export interface GetBenzingaV2News200ResponseResultsInner { + /** + * The name of the journalist or entity that authored the news article. + * @type {string} + * @memberof GetBenzingaV2News200ResponseResultsInner + */ + 'author': string; + /** + * The identifer used by Benzinga for this record. + * @type {number} + * @memberof GetBenzingaV2News200ResponseResultsInner + */ + 'benzinga_id': number; + /** + * The full text content of the news article. + * @type {string} + * @memberof GetBenzingaV2News200ResponseResultsInner + */ + 'body'?: string; + /** + * A list of categories or topics that the article belongs to (e.g., \'News\', \'Price Target\'). + * @type {Array} + * @memberof GetBenzingaV2News200ResponseResultsInner + */ + 'channels'?: Array; + /** + * A list of images associated with the article. + * @type {Array} + * @memberof GetBenzingaV2News200ResponseResultsInner + */ + 'images'?: Array; + /** + * The timestamp (formatted as an ISO 8601 timestamp) when the news article was last updated in the system. + * @type {string} + * @memberof GetBenzingaV2News200ResponseResultsInner + */ + 'last_updated': string; + /** + * The timestamp (formatted as an ISO 8601 timestamp) when the news article was originally published. + * @type {string} + * @memberof GetBenzingaV2News200ResponseResultsInner + */ + 'published': string; + /** + * A list of tags that describe the themes or content of the article. + * @type {Array} + * @memberof GetBenzingaV2News200ResponseResultsInner + */ + 'tags'?: Array; + /** + * A short summary or lead-in to the news article\'s content. + * @type {string} + * @memberof GetBenzingaV2News200ResponseResultsInner + */ + 'teaser'?: string; + /** + * A list of stock or crypto tickers mentioned in the article. + * @type {Array} + * @memberof GetBenzingaV2News200ResponseResultsInner + */ + 'tickers'?: Array; + /** + * The headline of the news article. + * @type {string} + * @memberof GetBenzingaV2News200ResponseResultsInner + */ + 'title': string; + /** + * The direct link to the source of the news article. + * @type {string} + * @memberof GetBenzingaV2News200ResponseResultsInner + */ + 'url': string; +} /** * * @export @@ -3438,22 +3557,22 @@ export interface GetCryptoEMA200Response { * @type {string} * @memberof GetCryptoEMA200Response */ - 'request_id'?: string; + 'request_id': string; /** * * @type {GetCryptoEMA200ResponseResults} * @memberof GetCryptoEMA200Response */ - 'results'?: GetCryptoEMA200ResponseResults; + 'results': GetCryptoEMA200ResponseResults; /** * The status of this request\'s response. * @type {string} * @memberof GetCryptoEMA200Response */ - 'status'?: string; + 'status': string; } /** - * + * The results of the EMA indicator calculation. * @export * @interface GetCryptoEMA200ResponseResults */ @@ -3465,20 +3584,20 @@ export interface GetCryptoEMA200ResponseResults { */ 'underlying'?: GetCryptoEMA200ResponseResultsUnderlying; /** - * + * Timestamp or indicator value. * @type {Array} * @memberof GetCryptoEMA200ResponseResults */ 'values'?: Array; } /** - * + * The underlying aggregates used. * @export * @interface GetCryptoEMA200ResponseResultsUnderlying */ export interface GetCryptoEMA200ResponseResultsUnderlying { /** - * + * The array of aggregates used in the calculation of this indicator. * @type {Array} * @memberof GetCryptoEMA200ResponseResultsUnderlying */ @@ -3564,7 +3683,7 @@ export interface GetCryptoEMA200ResponseResultsValuesInner { */ 'timestamp'?: number; /** - * The indicator value for this period. + * The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters. * @type {number} * @memberof GetCryptoEMA200ResponseResultsValuesInner */ @@ -3587,22 +3706,22 @@ export interface GetCryptoMACD200Response { * @type {string} * @memberof GetCryptoMACD200Response */ - 'request_id'?: string; + 'request_id': string; /** * * @type {GetCryptoMACD200ResponseResults} * @memberof GetCryptoMACD200Response */ - 'results'?: GetCryptoMACD200ResponseResults; + 'results': GetCryptoMACD200ResponseResults; /** * The status of this request\'s response. * @type {string} * @memberof GetCryptoMACD200Response */ - 'status'?: string; + 'status': string; } /** - * + * The results of the MACD indicator calculation. * @export * @interface GetCryptoMACD200ResponseResults */ @@ -3614,7 +3733,7 @@ export interface GetCryptoMACD200ResponseResults { */ 'underlying'?: GetCryptoEMA200ResponseResultsUnderlying; /** - * + * Each entry in the values array represents MACD indicator data for a specific timestamp and includes: * @type {Array} * @memberof GetCryptoMACD200ResponseResults */ @@ -3627,13 +3746,13 @@ export interface GetCryptoMACD200ResponseResults { */ export interface GetCryptoMACD200ResponseResultsValuesInner { /** - * The indicator value for this period. + * The difference between the MACD line (value) and the signal line (signal). Positive histogram values indicate upward (bullish) momentum, while negative histogram values indicate downward (bearish) momentum. * @type {number} * @memberof GetCryptoMACD200ResponseResultsValuesInner */ 'histogram'?: number; /** - * The indicator value for this period. + * The signal line value, calculated as the exponential moving average (EMA) of the MACD line (value) over the signal period defined in the request parameters. Traders typically use crossovers between the MACD and signal lines as trading signals. * @type {number} * @memberof GetCryptoMACD200ResponseResultsValuesInner */ @@ -3645,7 +3764,7 @@ export interface GetCryptoMACD200ResponseResultsValuesInner { */ 'timestamp'?: number; /** - * The indicator value for this period. + * The MACD line value, calculated as the difference between the short-term and long-term exponential moving averages (EMAs) based on the periods specified in the request parameters. * @type {number} * @memberof GetCryptoMACD200ResponseResultsValuesInner */ @@ -3717,22 +3836,22 @@ export interface GetCryptoRSI200Response { * @type {string} * @memberof GetCryptoRSI200Response */ - 'request_id'?: string; + 'request_id': string; /** * * @type {GetCryptoRSI200ResponseResults} * @memberof GetCryptoRSI200Response */ - 'results'?: GetCryptoRSI200ResponseResults; + 'results': GetCryptoRSI200ResponseResults; /** * The status of this request\'s response. * @type {string} * @memberof GetCryptoRSI200Response */ - 'status'?: string; + 'status': string; } /** - * + * The results of the RSI indicator calculation. * @export * @interface GetCryptoRSI200ResponseResults */ @@ -3744,7 +3863,7 @@ export interface GetCryptoRSI200ResponseResults { */ 'underlying'?: GetCryptoEMA200ResponseResultsUnderlying; /** - * + * Timestamp or indicator value. * @type {Array} * @memberof GetCryptoRSI200ResponseResults */ @@ -3767,22 +3886,22 @@ export interface GetCryptoSMA200Response { * @type {string} * @memberof GetCryptoSMA200Response */ - 'request_id'?: string; + 'request_id': string; /** * * @type {GetCryptoSMA200ResponseResults} * @memberof GetCryptoSMA200Response */ - 'results'?: GetCryptoSMA200ResponseResults; + 'results': GetCryptoSMA200ResponseResults; /** * The status of this request\'s response. * @type {string} * @memberof GetCryptoSMA200Response */ - 'status'?: string; + 'status': string; } /** - * + * The results of the SMA indicator calculation. * @export * @interface GetCryptoSMA200ResponseResults */ @@ -3794,7 +3913,7 @@ export interface GetCryptoSMA200ResponseResults { */ 'underlying'?: GetCryptoEMA200ResponseResultsUnderlying; /** - * + * Timestamp or indicator value. * @type {Array} * @memberof GetCryptoSMA200ResponseResults */ @@ -3851,7 +3970,7 @@ export interface GetCryptoSnapshotTicker200ResponseAllOfTicker { */ 'day': GetCryptoSnapshotTickers200ResponseAllOfTickersInnerDay; /** - * Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us. + * Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us. * @type {number} * @memberof GetCryptoSnapshotTicker200ResponseAllOfTicker */ @@ -3931,7 +4050,7 @@ export interface GetCryptoSnapshotTickers200ResponseAllOfTickersInner { */ 'day': GetCryptoSnapshotTickers200ResponseAllOfTickersInnerDay; /** - * Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us. + * Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInner */ @@ -4059,7 +4178,7 @@ export interface GetCryptoSnapshotTickers200ResponseAllOfTickersInnerLastTrade { */ 't': number; /** - * The exchange that this crypto trade happened on. See Exchanges for a mapping of exchanges to IDs. + * The exchange that this crypto trade happened on. See Exchanges for a mapping of exchanges to IDs. * @type {number} * @memberof GetCryptoSnapshotTickers200ResponseAllOfTickersInnerLastTrade */ @@ -4207,7 +4326,7 @@ export interface GetCryptoTrades200ResponseResultsInner { */ 'conditions'?: Array; /** - * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. + * The exchange ID. See Exchanges for Massive.com\'s mapping of exchange IDs. * @type {number} * @memberof GetCryptoTrades200ResponseResultsInner */ @@ -4237,6 +4356,77 @@ export interface GetCryptoTrades200ResponseResultsInner { */ 'size': number; } +/** + * + * @export + * @interface GetCryptoV1Exchanges200Response + */ +export interface GetCryptoV1Exchanges200Response { + /** + * If present, this value can be used to fetch the next page. + * @type {string} + * @memberof GetCryptoV1Exchanges200Response + */ + 'next_url'?: string; + /** + * A request id assigned by the server. + * @type {string} + * @memberof GetCryptoV1Exchanges200Response + */ + 'request_id': string; + /** + * The results for this request. + * @type {Array} + * @memberof GetCryptoV1Exchanges200Response + */ + 'results': Array; + /** + * The status of this request\'s response. + * @type {string} + * @memberof GetCryptoV1Exchanges200Response + */ + 'status': GetCryptoV1Exchanges200ResponseStatusEnum; +} + +/** + * @export + * @enum {string} + */ +export enum GetCryptoV1Exchanges200ResponseStatusEnum { + Ok = 'OK' +} + +/** + * + * @export + * @interface GetCryptoV1Exchanges200ResponseResultsInner + */ +export interface GetCryptoV1Exchanges200ResponseResultsInner { + /** + * Numeric identifier for the cryptocurrency exchange or trading platform. + * @type {string} + * @memberof GetCryptoV1Exchanges200ResponseResultsInner + */ + 'id': string; + /** + * Full official name of the cryptocurrency exchange or digital asset trading platform. + * @type {string} + * @memberof GetCryptoV1Exchanges200ResponseResultsInner + */ + 'name': string; + /** + * Type of crypto venue - \'exchange\' for cryptocurrency exchanges and digital asset trading platforms. + * @type {string} + * @memberof GetCryptoV1Exchanges200ResponseResultsInner + */ + 'type': string; + /** + * Official website URL of the cryptocurrency exchange. + * @type {string} + * @memberof GetCryptoV1Exchanges200ResponseResultsInner + */ + 'url'?: string; +} /** * * @export @@ -4311,7 +4501,7 @@ export interface GetCurrencyConversion200ResponseLast { */ 'bid': number; /** - * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. + * The exchange ID. See Exchanges for Massive.com\'s mapping of exchange IDs. * @type {number} * @memberof GetCurrencyConversion200ResponseLast */ @@ -4326,3890 +4516,3889 @@ export interface GetCurrencyConversion200ResponseLast { /** * * @export - * @interface GetEvents200Response + * @interface GetEtfGlobalV1Analytics200Response */ -export interface GetEvents200Response { +export interface GetEtfGlobalV1Analytics200Response { /** - * A request id assigned by the server. + * If present, this value can be used to fetch the next page. * @type {string} - * @memberof GetEvents200Response - */ - 'request_id'?: string; - /** - * - * @type {GetEvents200ResponseResults} - * @memberof GetEvents200Response + * @memberof GetEtfGlobalV1Analytics200Response */ - 'results'?: GetEvents200ResponseResults; + 'next_url'?: string; /** - * The status of this request\'s response. + * A request id assigned by the server. * @type {string} - * @memberof GetEvents200Response + * @memberof GetEtfGlobalV1Analytics200Response */ - 'status'?: string; -} -/** - * Contains the requested event data for the specified ticker. - * @export - * @interface GetEvents200ResponseResults - */ -export interface GetEvents200ResponseResults { + 'request_id': string; /** - * An array of event containing the requested data. - * @type {Array} - * @memberof GetEvents200ResponseResults + * The results for this request. + * @type {Array} + * @memberof GetEtfGlobalV1Analytics200Response */ - 'events'?: Array; + 'results': Array; /** - * The name of the asset. + * The status of this request\'s response. * @type {string} - * @memberof GetEvents200ResponseResults + * @memberof GetEtfGlobalV1Analytics200Response */ - 'name'?: string; + 'status': GetEtfGlobalV1Analytics200ResponseStatusEnum; } + /** - * @type GetEvents200ResponseResultsEventsInner - * @export - */ -export type GetEvents200ResponseResultsEventsInner = GetEvents200ResponseResultsEventsInnerOneOf; + * @export + * @enum {string} + */ +export enum GetEtfGlobalV1Analytics200ResponseStatusEnum { + Ok = 'OK' +} /** * * @export - * @interface GetEvents200ResponseResultsEventsInnerOneOf + * @interface GetEtfGlobalV1Analytics200ResponseResultsInner */ -export interface GetEvents200ResponseResultsEventsInnerOneOf { +export interface GetEtfGlobalV1Analytics200ResponseResultsInner { /** - * The date the event took place + * The stock ticker symbol used to identify this ETF product on exchanges. * @type {string} - * @memberof GetEvents200ResponseResultsEventsInnerOneOf + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner */ - 'date': string; + 'composite_ticker'?: string; /** - * The type of historical event for the asset + * The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. * @type {string} - * @memberof GetEvents200ResponseResultsEventsInnerOneOf + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner */ - 'event_type': string; + 'effective_date'?: string; /** - * - * @type {GetEvents200ResponseResultsEventsInnerOneOfTickerChange} - * @memberof GetEvents200ResponseResultsEventsInnerOneOf + * The date showing when ETF Global received and processed the data. + * @type {string} + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner */ - 'ticker_change'?: GetEvents200ResponseResultsEventsInnerOneOfTickerChange; -} -/** - * Details about a ticker change - * @export - * @interface GetEvents200ResponseResultsEventsInnerOneOfTickerChange - */ -export interface GetEvents200ResponseResultsEventsInnerOneOfTickerChange { + 'processed_date'?: string; /** - * A ticker symbol - * @type {string} - * @memberof GetEvents200ResponseResultsEventsInnerOneOfTickerChange + * Behavioral analysis score measuring investor psychology and market behavior patterns. + * @type {number} + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner */ - 'ticker'?: string; -} -/** - * - * @export - * @interface GetFedV1Inflation200Response - */ -export interface GetFedV1Inflation200Response { + 'quant_composite_behavioral'?: number; /** - * If present, this value can be used to fetch the next page. - * @type {string} - * @memberof GetFedV1Inflation200Response + * Overall fundamental analysis score combining P/E, P/CF, P/B, and dividend yield metrics. + * @type {number} + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner */ - 'next_url'?: string; + 'quant_composite_fundamental'?: number; /** - * A request id assigned by the server. - * @type {string} - * @memberof GetFedV1Inflation200Response + * Overall global theme score combining sector and country analysis for macro investment views. + * @type {number} + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner */ - 'request_id': string; + 'quant_composite_global'?: number; /** - * The results for this request. - * @type {Array} - * @memberof GetFedV1Inflation200Response + * Overall quality assessment score combining liquidity, diversification, and issuing firm factors. + * @type {number} + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner */ - 'results': Array; + 'quant_composite_quality'?: number; /** - * The status of this request\'s response. - * @type {string} - * @memberof GetFedV1Inflation200Response + * Overall market sentiment score combining put/call ratios, short interest, and implied volatility. + * @type {number} + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner */ - 'status': GetFedV1Inflation200ResponseStatusEnum; -} - -/** - * @export - * @enum {string} - */ -export enum GetFedV1Inflation200ResponseStatusEnum { - Ok = 'OK' -} - -/** - * - * @export - * @interface GetFedV1Inflation200ResponseResultsInner - */ -export interface GetFedV1Inflation200ResponseResultsInner { + 'quant_composite_sentiment'?: number; /** - * Consumer Price Index (CPI) for All Urban Consumers — a standard measure of headline inflation based on a fixed basket of goods and services, not seasonally adjusted. + * Combined technical analysis score aggregating short, intermediate, and long-term technical factors. * @type {number} - * @memberof GetFedV1Inflation200ResponseResultsInner + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner */ - 'cpi'?: number; + 'quant_composite_technical'?: number; /** - * Core Consumer Price Index — the CPI excluding food and energy, used to understand underlying inflation trends without short-term volatility. + * Fundamental analysis score based on dividend yields of the ETF\'s underlying securities. * @type {number} - * @memberof GetFedV1Inflation200ResponseResultsInner + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner */ - 'cpi_core'?: number; + 'quant_fundamental_div'?: number; /** - * Year-over-year percentage change in the headline CPI — the most commonly cited inflation rate in public discourse and economic policy. + * Fundamental analysis score based on price-to-book value ratios of the ETF\'s holdings. * @type {number} - * @memberof GetFedV1Inflation200ResponseResultsInner + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner */ - 'cpi_year_over_year'?: number; + 'quant_fundamental_pb'?: number; /** - * Calendar date of the observation (YYYY‑MM‑DD). - * @type {string} - * @memberof GetFedV1Inflation200ResponseResultsInner + * Fundamental analysis score based on price-to-cash-flow ratios of the ETF\'s underlying assets. + * @type {number} + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner */ - 'date'?: string; + 'quant_fundamental_pcf'?: number; /** - * Personal Consumption Expenditures (PCE) Price Index — a broader measure of inflation used by the Federal Reserve, reflecting actual consumer spending patterns and updated basket weights. + * Fundamental analysis score based on price-to-earnings ratios of the ETF\'s underlying holdings. * @type {number} - * @memberof GetFedV1Inflation200ResponseResultsInner + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner */ - 'pce'?: number; + 'quant_fundamental_pe'?: number; /** - * Core PCE Price Index — excludes food and energy prices from the PCE index, and is the Fed\'s preferred measure of underlying inflation. + * Quantitative score analyzing global country themes and country-specific market factors. * @type {number} - * @memberof GetFedV1Inflation200ResponseResultsInner + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner */ - 'pce_core'?: number; + 'quant_global_country'?: number; /** - * Nominal Personal Consumption Expenditures — total dollar value of consumer spending in the U.S. economy, reported in billions of dollars and not adjusted for inflation. + * Quantitative score analyzing global sector themes and sector-specific performance factors. * @type {number} - * @memberof GetFedV1Inflation200ResponseResultsInner + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner */ - 'pce_spending'?: number; -} -/** - * - * @export - * @interface GetFedV1InflationExpectations200Response - */ -export interface GetFedV1InflationExpectations200Response { + 'quant_global_sector'?: number; /** - * If present, this value can be used to fetch the next page. + * Letter grade summarizing the ETF\'s overall quantitative assessment, where A = 71-100, B = 56-70, etc. * @type {string} - * @memberof GetFedV1InflationExpectations200Response + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner */ - 'next_url'?: string; + 'quant_grade'?: string; /** - * A request id assigned by the server. - * @type {string} - * @memberof GetFedV1InflationExpectations200Response + * Quality assessment score evaluating the diversification benefits and risk distribution of the ETF. + * @type {number} + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner */ - 'request_id': string; + 'quant_quality_diversification'?: number; /** - * The results for this request. - * @type {Array} - * @memberof GetFedV1InflationExpectations200Response + * Quality assessment score evaluating the reputation and capabilities of the ETF\'s issuing firm. + * @type {number} + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner */ - 'results': Array; + 'quant_quality_firm'?: number; /** - * The status of this request\'s response. - * @type {string} - * @memberof GetFedV1InflationExpectations200Response + * Quality assessment score measuring the liquidity characteristics and trading ease of the ETF. + * @type {number} + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner */ - 'status': GetFedV1InflationExpectations200ResponseStatusEnum; -} - -/** - * @export - * @enum {string} - */ -export enum GetFedV1InflationExpectations200ResponseStatusEnum { - Ok = 'OK' -} - -/** - * - * @export - * @interface GetFedV1InflationExpectations200ResponseResultsInner - */ -export interface GetFedV1InflationExpectations200ResponseResultsInner { + 'quant_quality_liquidity'?: number; /** - * Calendar date of the observation (YYYY‑MM‑DD). - * @type {string} - * @memberof GetFedV1InflationExpectations200ResponseResultsInner + * Market sentiment score derived from implied volatility levels in options markets. + * @type {number} + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner */ - 'date'?: string; + 'quant_sentiment_iv'?: number; /** - * 5-Year, 5-Year Forward Inflation Expectation Rate — the market\'s expectation of average annual inflation for the 5-year period beginning 5 years from now, based on the spread between forward nominal and real yields. + * Market sentiment score derived from put/call option ratios and options activity. * @type {number} - * @memberof GetFedV1InflationExpectations200ResponseResultsInner + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner */ - 'forward_years_5_to_10'?: number; + 'quant_sentiment_pc'?: number; /** - * 10-Year Breakeven Inflation Rate — the market\'s expectation of average annual inflation over the next 10 years, based on the spread between 10-year nominal Treasury yields and 10-year TIPS yields. + * Market sentiment score based on short interest levels and short selling activity. * @type {number} - * @memberof GetFedV1InflationExpectations200ResponseResultsInner + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner */ - 'market_10_year'?: number; + 'quant_sentiment_si'?: number; /** - * 5-Year Breakeven Inflation Rate — the market\'s expectation of average annual inflation over the next 5 years, based on the spread between 5-year nominal Treasury yields and 5-year TIPS yields. + * Intermediate-term technical analysis score evaluating medium-term price trends. * @type {number} - * @memberof GetFedV1InflationExpectations200ResponseResultsInner + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner */ - 'market_5_year'?: number; + 'quant_technical_it'?: number; /** - * The Cleveland Fed’s 10-year inflation expectations data estimated expected inflation, risk premiums, and the real interest rate using a model based on Treasury yields, inflation data, swaps, and surveys. + * Long-term technical analysis score assessing extended price trend patterns. * @type {number} - * @memberof GetFedV1InflationExpectations200ResponseResultsInner + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner */ - 'model_10_year'?: number; + 'quant_technical_lt'?: number; /** - * The Cleveland Fed’s 1-year inflation expectations data estimated expected inflation, risk premiums, and the real interest rate using a model based on Treasury yields, inflation data, swaps, and surveys. + * Short-term technical analysis score based on recent price movements and trading patterns. * @type {number} - * @memberof GetFedV1InflationExpectations200ResponseResultsInner + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner */ - 'model_1_year'?: number; + 'quant_technical_st'?: number; /** - * The Cleveland Fed’s 30-year inflation expectations data estimated expected inflation, risk premiums, and the real interest rate using a model based on Treasury yields, inflation data, swaps, and surveys. + * ETF Global\'s comprehensive quantitative analysis score combining all quantitative factors. * @type {number} - * @memberof GetFedV1InflationExpectations200ResponseResultsInner + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner */ - 'model_30_year'?: number; + 'quant_total_score'?: number; /** - * The Cleveland Fed’s 5-year inflation expectations data estimated expected inflation, risk premiums, and the real interest rate using a model based on Treasury yields, inflation data, swaps, and surveys. + * ETF Global\'s proprietary Green Diamond score measuring the potential reward and return prospects of the ETF. * @type {number} - * @memberof GetFedV1InflationExpectations200ResponseResultsInner + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner */ - 'model_5_year'?: number; + 'reward_score'?: number; + /** + * A component score assessing country-specific risks based on the ETF\'s geographic exposure. + * @type {number} + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner + */ + 'risk_country'?: number; + /** + * A component score measuring how much the ETF deviates from expected performance. + * @type {number} + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner + */ + 'risk_deviation'?: number; + /** + * A component score assessing the operational efficiency and cost-effectiveness of the ETF. + * @type {number} + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner + */ + 'risk_efficiency'?: number; + /** + * A component score measuring the liquidity risk and ease of trading the ETF. + * @type {number} + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner + */ + 'risk_liquidity'?: number; + /** + * A component score evaluating risks related to the ETF\'s structural design and mechanics. + * @type {number} + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner + */ + 'risk_structure'?: number; + /** + * ETF Global\'s proprietary Red Diamond overall risk assessment score for the ETF. + * @type {number} + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner + */ + 'risk_total_score'?: number; + /** + * A component score measuring the volatility risk of the ETF\'s price movements. + * @type {number} + * @memberof GetEtfGlobalV1Analytics200ResponseResultsInner + */ + 'risk_volatility'?: number; } /** * * @export - * @interface GetFedV1TreasuryYields200Response + * @interface GetEtfGlobalV1Constituents200Response */ -export interface GetFedV1TreasuryYields200Response { +export interface GetEtfGlobalV1Constituents200Response { /** * If present, this value can be used to fetch the next page. * @type {string} - * @memberof GetFedV1TreasuryYields200Response + * @memberof GetEtfGlobalV1Constituents200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} - * @memberof GetFedV1TreasuryYields200Response + * @memberof GetEtfGlobalV1Constituents200Response */ 'request_id': string; /** * The results for this request. - * @type {Array} - * @memberof GetFedV1TreasuryYields200Response + * @type {Array} + * @memberof GetEtfGlobalV1Constituents200Response */ - 'results': Array; + 'results': Array; /** * The status of this request\'s response. * @type {string} - * @memberof GetFedV1TreasuryYields200Response + * @memberof GetEtfGlobalV1Constituents200Response */ - 'status': GetFedV1TreasuryYields200ResponseStatusEnum; + 'status': GetEtfGlobalV1Constituents200ResponseStatusEnum; } /** * @export * @enum {string} */ -export enum GetFedV1TreasuryYields200ResponseStatusEnum { +export enum GetEtfGlobalV1Constituents200ResponseStatusEnum { Ok = 'OK' } /** * * @export - * @interface GetFedV1TreasuryYields200ResponseResultsInner + * @interface GetEtfGlobalV1Constituents200ResponseResultsInner */ -export interface GetFedV1TreasuryYields200ResponseResultsInner { +export interface GetEtfGlobalV1Constituents200ResponseResultsInner { /** - * Calendar date of the yield observation (YYYY-MM-DD). + * The broad category of asset type, such as Equity, Corporate Bond, Municipal Bond, etc. * @type {string} - * @memberof GetFedV1TreasuryYields200ResponseResultsInner + * @memberof GetEtfGlobalV1Constituents200ResponseResultsInner */ - 'date'?: string; + 'asset_class'?: string; /** - * Market Yield on U.S. Treasury Securities at 10-Year Constant Maturity, Quoted on an Investment Basis - * @type {number} - * @memberof GetFedV1TreasuryYields200ResponseResultsInner + * The stock ticker symbol of the ETF that holds these constituent securities. + * @type {string} + * @memberof GetEtfGlobalV1Constituents200ResponseResultsInner */ - 'yield_10_year'?: number; + 'composite_ticker'?: string; /** - * Market Yield on U.S. Treasury Securities at 1-Month Constant Maturity, Quoted on an Investment Basis - * @type {number} - * @memberof GetFedV1TreasuryYields200ResponseResultsInner + * The full company or security name of the constituent holding. + * @type {string} + * @memberof GetEtfGlobalV1Constituents200ResponseResultsInner */ - 'yield_1_month'?: number; + 'constituent_name'?: string; /** - * Market Yield on U.S. Treasury Securities at 1-Year Constant Maturity, Quoted on an Investment Basis - * @type {number} - * @memberof GetFedV1TreasuryYields200ResponseResultsInner + * The stock ticker symbol of the individual security held within the ETF. + * @type {string} + * @memberof GetEtfGlobalV1Constituents200ResponseResultsInner */ - 'yield_1_year'?: number; + 'constituent_ticker'?: string; /** - * Market Yield on U.S. Treasury Securities at 20-Year Constant Maturity, Quoted on an Investment Basis - * @type {number} - * @memberof GetFedV1TreasuryYields200ResponseResultsInner + * The country where the exchange that lists this constituent security is located. + * @type {string} + * @memberof GetEtfGlobalV1Constituents200ResponseResultsInner */ - 'yield_20_year'?: number; + 'country_of_exchange'?: string; /** - * Market Yield on U.S. Treasury Securities at 2-Year Constant Maturity, Quoted on an Investment Basis - * @type {number} - * @memberof GetFedV1TreasuryYields200ResponseResultsInner + * The local currency in which this constituent security is denominated and traded. + * @type {string} + * @memberof GetEtfGlobalV1Constituents200ResponseResultsInner */ - 'yield_2_year'?: number; + 'currency_traded'?: string; /** - * Market Yield on U.S. Treasury Securities at 30-Year Constant Maturity, Quoted on an Investment Basis - * @type {number} - * @memberof GetFedV1TreasuryYields200ResponseResultsInner + * The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. + * @type {string} + * @memberof GetEtfGlobalV1Constituents200ResponseResultsInner */ - 'yield_30_year'?: number; + 'effective_date'?: string; /** - * Market Yield on U.S. Treasury Securities at 3-Month Constant Maturity, Quoted on an Investment Basis - * @type {number} - * @memberof GetFedV1TreasuryYields200ResponseResultsInner + * The name of the stock exchange where this constituent security is primarily traded. + * @type {string} + * @memberof GetEtfGlobalV1Constituents200ResponseResultsInner */ - 'yield_3_month'?: number; + 'exchange'?: string; /** - * Market Yield on U.S. Treasury Securities at 3-Year Constant Maturity, Quoted on an Investment Basis - * @type {number} - * @memberof GetFedV1TreasuryYields200ResponseResultsInner + * The Financial Instrument Global Identifier, an open standard for uniquely identifying financial instruments. + * @type {string} + * @memberof GetEtfGlobalV1Constituents200ResponseResultsInner */ - 'yield_3_year'?: number; + 'figi'?: string; /** - * Market Yield on U.S. Treasury Securities at 5-Year Constant Maturity, Quoted on an Investment Basis + * The International Securities Identification Number, a global standard for identifying securities. + * @type {string} + * @memberof GetEtfGlobalV1Constituents200ResponseResultsInner + */ + 'isin'?: string; + /** + * The total market value of this constituent position held by the ETF. * @type {number} - * @memberof GetFedV1TreasuryYields200ResponseResultsInner + * @memberof GetEtfGlobalV1Constituents200ResponseResultsInner */ - 'yield_5_year'?: number; + 'market_value'?: number; /** - * Market Yield on U.S. Treasury Securities at 6-Month Constant Maturity, Quoted on an Investment Basis + * The date showing when ETF Global received and processed the data. + * @type {string} + * @memberof GetEtfGlobalV1Constituents200ResponseResultsInner + */ + 'processed_date'?: string; + /** + * The specific classification of security type using ETF Global\'s taxonomy, such as Common Equity, Domestic, Global, etc. + * @type {string} + * @memberof GetEtfGlobalV1Constituents200ResponseResultsInner + */ + 'security_type'?: string; + /** + * The Stock Exchange Daily Official List code, primarily used for securities trading in the UK. + * @type {string} + * @memberof GetEtfGlobalV1Constituents200ResponseResultsInner + */ + 'sedol'?: string; + /** + * The number of shares of this constituent security that the ETF currently owns. * @type {number} - * @memberof GetFedV1TreasuryYields200ResponseResultsInner + * @memberof GetEtfGlobalV1Constituents200ResponseResultsInner */ - 'yield_6_month'?: number; + 'shares_held'?: number; /** - * Market Yield on U.S. Treasury Securities at 7-Year Constant Maturity, Quoted on an Investment Basis + * A unique identifier code for the constituent security in US markets. + * @type {string} + * @memberof GetEtfGlobalV1Constituents200ResponseResultsInner + */ + 'us_code'?: string; + /** + * The percentage weight of this constituent security within the ETF\'s total portfolio. * @type {number} - * @memberof GetFedV1TreasuryYields200ResponseResultsInner + * @memberof GetEtfGlobalV1Constituents200ResponseResultsInner */ - 'yield_7_year'?: number; + 'weight'?: number; } /** * * @export - * @interface GetForexQuotes200Response + * @interface GetEtfGlobalV1FundFlows200Response */ -export interface GetForexQuotes200Response { +export interface GetEtfGlobalV1FundFlows200Response { /** - * If present, this value can be used to fetch the next page of data. + * If present, this value can be used to fetch the next page. * @type {string} - * @memberof GetForexQuotes200Response + * @memberof GetEtfGlobalV1FundFlows200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} - * @memberof GetForexQuotes200Response + * @memberof GetEtfGlobalV1FundFlows200Response */ - 'request_id'?: string; + 'request_id': string; /** - * An array of results containing the requested data. - * @type {Array} - * @memberof GetForexQuotes200Response + * The results for this request. + * @type {Array} + * @memberof GetEtfGlobalV1FundFlows200Response */ - 'results'?: Array; + 'results': Array; /** * The status of this request\'s response. * @type {string} - * @memberof GetForexQuotes200Response + * @memberof GetEtfGlobalV1FundFlows200Response */ - 'status': string; + 'status': GetEtfGlobalV1FundFlows200ResponseStatusEnum; +} + +/** + * @export + * @enum {string} + */ +export enum GetEtfGlobalV1FundFlows200ResponseStatusEnum { + Ok = 'OK' } + /** * * @export - * @interface GetForexQuotes200ResponseResultsInner + * @interface GetEtfGlobalV1FundFlows200ResponseResultsInner */ -export interface GetForexQuotes200ResponseResultsInner { +export interface GetEtfGlobalV1FundFlows200ResponseResultsInner { /** - * The ask exchange ID - * @type {number} - * @memberof GetForexQuotes200ResponseResultsInner + * The stock ticker symbol used to identify this ETF on exchanges. + * @type {string} + * @memberof GetEtfGlobalV1FundFlows200ResponseResultsInner */ - 'ask_exchange'?: number; + 'composite_ticker'?: string; /** - * The ask price. - * @type {number} - * @memberof GetForexQuotes200ResponseResultsInner + * The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. + * @type {string} + * @memberof GetEtfGlobalV1FundFlows200ResponseResultsInner */ - 'ask_price'?: number; + 'effective_date'?: string; /** - * The bid exchange ID + * The net daily capital flow into or out of the ETF through the creation and redemption process, where positive values indicate inflows and negative values indicate outflows. * @type {number} - * @memberof GetForexQuotes200ResponseResultsInner + * @memberof GetEtfGlobalV1FundFlows200ResponseResultsInner */ - 'bid_exchange'?: number; + 'fund_flow'?: number; /** - * The bid price. + * The net asset value per share, representing the per-share value of the ETF\'s underlying holdings. * @type {number} - * @memberof GetForexQuotes200ResponseResultsInner + * @memberof GetEtfGlobalV1FundFlows200ResponseResultsInner */ - 'bid_price'?: number; + 'nav'?: number; /** - * The nanosecond Exchange Unix Timestamp. This is the timestamp of when the quote was generated at the exchange. + * The date showing when ETF Global received and processed the data. + * @type {string} + * @memberof GetEtfGlobalV1FundFlows200ResponseResultsInner + */ + 'processed_date'?: string; + /** + * The total number of ETF shares currently issued and outstanding in the market. * @type {number} - * @memberof GetForexQuotes200ResponseResultsInner + * @memberof GetEtfGlobalV1FundFlows200ResponseResultsInner */ - 'participant_timestamp': number; + 'shares_outstanding'?: number; } /** * * @export - * @interface GetForexSnapshotTicker200Response + * @interface GetEtfGlobalV1Profiles200Response */ -export interface GetForexSnapshotTicker200Response { +export interface GetEtfGlobalV1Profiles200Response { /** - * The status of this request\'s response. + * If present, this value can be used to fetch the next page. * @type {string} - * @memberof GetForexSnapshotTicker200Response + * @memberof GetEtfGlobalV1Profiles200Response */ - 'status': string; + 'next_url'?: string; /** * A request id assigned by the server. * @type {string} - * @memberof GetForexSnapshotTicker200Response + * @memberof GetEtfGlobalV1Profiles200Response */ 'request_id': string; /** - * - * @type {GetForexSnapshotTicker200ResponseAllOfTicker} - * @memberof GetForexSnapshotTicker200Response + * The results for this request. + * @type {Array} + * @memberof GetEtfGlobalV1Profiles200Response */ - 'ticker'?: GetForexSnapshotTicker200ResponseAllOfTicker; + 'results': Array; + /** + * The status of this request\'s response. + * @type {string} + * @memberof GetEtfGlobalV1Profiles200Response + */ + 'status': GetEtfGlobalV1Profiles200ResponseStatusEnum; } + /** - * Contains the requested snapshot data for the specified ticker. + * @export + * @enum {string} + */ +export enum GetEtfGlobalV1Profiles200ResponseStatusEnum { + Ok = 'OK' +} + +/** + * * @export - * @interface GetForexSnapshotTicker200ResponseAllOfTicker + * @interface GetEtfGlobalV1Profiles200ResponseResultsInner */ -export interface GetForexSnapshotTicker200ResponseAllOfTicker { +export interface GetEtfGlobalV1Profiles200ResponseResultsInner { /** - * - * @type {GetForexSnapshotTickers200ResponseAllOfTickersInnerDay} - * @memberof GetForexSnapshotTicker200ResponseAllOfTicker + * The administrator of the ETF. + * @type {string} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'day': GetForexSnapshotTickers200ResponseAllOfTickersInnerDay; + 'administrator'?: string; + /** + * The investment advisor of the ETF. + * @type {string} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner + */ + 'advisor'?: string; + /** + * The primary type of assets held by the ETF, such as equities, bonds, commodities, or other securities. + * @type {string} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner + */ + 'asset_class'?: string; /** - * Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us. + * The total assets under management, representing the current market value of all assets held by the ETF. * @type {number} - * @memberof GetForexSnapshotTicker200ResponseAllOfTicker + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'fmv'?: number; + 'aum'?: number; /** - * - * @type {GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote} - * @memberof GetForexSnapshotTicker200ResponseAllOfTicker + * The average number of shares traded daily over the past month, indicating liquidity and investor interest. + * @type {number} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'lastQuote': GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote; + 'avg_daily_trading_volume'?: number; /** - * - * @type {GetForexSnapshotTickers200ResponseAllOfTickersInnerMin} - * @memberof GetForexSnapshotTicker200ResponseAllOfTicker + * The average intraday bid-ask spread as a percentage, calculated by dividing the spread by the lowest ask price sampled during the day. + * @type {number} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'min': GetForexSnapshotTickers200ResponseAllOfTickersInnerMin; + 'bid_ask_spread'?: number; /** - * - * @type {GetCryptoSnapshotTickers200ResponseAllOfTickersInnerPrevDay} - * @memberof GetForexSnapshotTicker200ResponseAllOfTicker + * Call options volume. + * @type {number} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'prevDay': GetCryptoSnapshotTickers200ResponseAllOfTickersInnerPrevDay; + 'call_volume'?: number; /** - * The exchange symbol that this item is traded under. + * The broad investment category that describes the ETF\'s investment focus and strategy. * @type {string} - * @memberof GetForexSnapshotTicker200ResponseAllOfTicker + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'ticker': string; + 'category'?: string; /** - * The value of the change from the previous day. - * @type {number} - * @memberof GetForexSnapshotTicker200ResponseAllOfTicker + * The stock ticker symbol used to identify this ETF product on exchanges. + * @type {string} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'todaysChange': number; + 'composite_ticker'?: string; /** - * The percentage change since the previous day. + * Coupon exposure breakdown for fixed income ETFs. + * @type {Array} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner + */ + 'coupon_exposure'?: Array; + /** + * The fee for creating new shares of the ETF. * @type {number} - * @memberof GetForexSnapshotTicker200ResponseAllOfTicker + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'todaysChangePerc': number; + 'creation_fee'?: number; /** - * The last updated timestamp. + * The size of creation units for the ETF. * @type {number} - * @memberof GetForexSnapshotTicker200ResponseAllOfTicker + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'updated': number; -} -/** - * - * @export - * @interface GetForexSnapshotTickers200Response - */ -export interface GetForexSnapshotTickers200Response { + 'creation_unit_size'?: number; /** - * The status of this request\'s response. + * Currency exposure breakdown of the ETF. + * @type {Array} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner + */ + 'currency_exposure'?: Array; + /** + * The custodian of the ETF assets. * @type {string} - * @memberof GetForexSnapshotTickers200Response + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'status': string; + 'custodian'?: string; /** - * An array of snapshot data for the specified tickers. - * @type {Array} - * @memberof GetForexSnapshotTickers200Response + * The official name and description of the ETF product. + * @type {string} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'tickers'?: Array; -} -/** - * - * @export - * @interface GetForexSnapshotTickers200ResponseAllOfTickersInner - */ -export interface GetForexSnapshotTickers200ResponseAllOfTickersInner { + 'description'?: string; /** - * - * @type {GetForexSnapshotTickers200ResponseAllOfTickersInnerDay} - * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInner + * The economic development classification of the markets the ETF invests in, such as developed, emerging, or frontier markets. + * @type {string} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'day': GetForexSnapshotTickers200ResponseAllOfTickersInnerDay; + 'development_class'?: string; /** - * Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us. + * Discount or premium to net asset value. * @type {number} - * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInner + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'fmv'?: number; + 'discount_premium'?: number; /** - * - * @type {GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote} - * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInner + * How frequently the ETF makes distributions. + * @type {string} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'lastQuote': GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote; + 'distribution_frequency'?: string; /** - * - * @type {GetForexSnapshotTickers200ResponseAllOfTickersInnerMin} - * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInner + * The distributor of the ETF. + * @type {string} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'min': GetForexSnapshotTickers200ResponseAllOfTickersInnerMin; + 'distributor'?: string; /** - * - * @type {GetCryptoSnapshotTickers200ResponseAllOfTickersInnerPrevDay} - * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInner + * The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. + * @type {string} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'prevDay': GetCryptoSnapshotTickers200ResponseAllOfTickersInnerPrevDay; + 'effective_date'?: string; /** - * The exchange symbol that this item is traded under. + * Any fee waivers applied to the ETF. + * @type {number} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner + */ + 'fee_waivers'?: number; + /** + * The fiscal year end date for the ETF. * @type {string} - * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInner + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'ticker': string; + 'fiscal_year_end'?: string; /** - * The value of the change from the previous day. - * @type {number} - * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInner + * The specific investment focus or exposure that the ETF provides, such as sector, geography, or investment style. + * @type {string} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'todaysChange': number; + 'focus'?: string; /** - * The percentage change since the previous day. - * @type {number} - * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInner + * The futures commission merchant, if applicable. + * @type {string} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'todaysChangePerc': number; + 'futures_commission_merchant'?: string; /** - * The last updated timestamp. - * @type {number} - * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInner + * Geographic exposure breakdown of the ETF. + * @type {Array} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'updated': number; -} -/** - * The most recent daily bar for this ticker. - * @export - * @interface GetForexSnapshotTickers200ResponseAllOfTickersInnerDay - */ -export interface GetForexSnapshotTickers200ResponseAllOfTickersInnerDay { + 'geographic_exposure'?: Array; /** - * The close price for the symbol in the given time period. - * @type {number} - * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerDay + * The date when this ETF was first launched and became available for trading. + * @type {string} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'c': number; + 'inception_date'?: string; /** - * The highest price for the symbol in the given time period. - * @type {number} - * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerDay + * Industry exposure breakdown of the ETF. + * @type {Array} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'h': number; + 'industry_exposure'?: Array; /** - * The lowest price for the symbol in the given time period. - * @type {number} - * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerDay + * Industry group exposure breakdown of the ETF. + * @type {Array} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'l': number; + 'industry_group_exposure'?: Array; /** - * The open price for the symbol in the given time period. - * @type {number} - * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerDay + * The financial institution or fund company that created and sponsors this ETF. + * @type {string} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'o': number; + 'issuer'?: string; /** - * The trading volume of the symbol in the given time period. - * @type {number} - * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerDay + * The lead market maker for the ETF. + * @type {string} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'v': number; -} -/** - * The most recent quote for this ticker. - * @export - * @interface GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote - */ -export interface GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote { + 'lead_market_maker'?: string; /** - * The ask price. - * @type {number} - * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote + * Indicates whether the ETF uses leverage to amplify returns (\'leveraged\'), or does not use leverage (\'unleveraged\'). + * @type {string} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'a': number; + 'leverage_style': string; /** - * The bid price. + * The leverage multiplier applied by the ETF, where positive numbers indicate leveraged exposure and negative numbers indicate inverse exposure. * @type {number} - * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'b': number; + 'levered_amount'?: number; /** - * The millisecond accuracy timestamp of the quote. - * @type {number} - * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote + * The primary exchange where the ETF is listed. + * @type {string} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 't': number; + 'listing_exchange'?: string; /** - * The exchange ID on which this quote happened. - * @type {number} - * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote + * Defines whether an ETF is considered active under SEC rules, with managers making investment decisions, or passive, tracking an index. + * @type {string} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'x': number; -} -/** - * The most recent minute bar for this ticker. - * @export - * @interface GetForexSnapshotTickers200ResponseAllOfTickersInnerMin - */ -export interface GetForexSnapshotTickers200ResponseAllOfTickersInnerMin { + 'management_classification': string; /** - * The close price for the symbol in the given time period. + * The annual fee charged by the fund manager for managing the ETF\'s portfolio and operations. * @type {number} - * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerMin + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'c'?: number; + 'management_fee'?: number; /** - * The highest price for the symbol in the given time period. - * @type {number} - * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerMin + * Maturity exposure breakdown for fixed income ETFs. + * @type {Array} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'h'?: number; + 'maturity_exposure'?: Array; /** - * The lowest price for the symbol in the given time period. + * Net expenses after waivers. * @type {number} - * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerMin + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'l'?: number; + 'net_expenses'?: number; /** - * The number of transactions in the aggregate window. + * Number of holdings in the ETF. * @type {number} - * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerMin + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'n'?: number; + 'num_holdings'?: number; /** - * The open price for the symbol in the given time period. + * Availability of options on the ETF. * @type {number} - * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerMin + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'o'?: number; + 'options_available'?: number; /** - * The Unix millisecond timestamp for the start of the aggregate window. + * Options trading volume for the ETF. * @type {number} - * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerMin + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 't'?: number; + 'options_volume'?: number; /** - * The trading volume of the symbol in the given time period. + * Other expenses charged by the ETF. * @type {number} - * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerMin + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'v'?: number; -} -/** - * - * @export - * @interface GetFuturesAggregates200Response - */ -export interface GetFuturesAggregates200Response { + 'other_expenses'?: number; /** - * If present, the URL to the next page of results. + * The portfolio manager of the ETF. * @type {string} - * @memberof GetFuturesAggregates200Response + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'next_url'?: string; + 'portfolio_manager'?: string; /** - * - * @type {Array} - * @memberof GetFuturesAggregates200Response + * The main index or benchmark that this ETF is designed to track or replicate. + * @type {string} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'results'?: Array; + 'primary_benchmark'?: string; /** - * The status of the response. + * The date showing when ETF Global received and processed the data. * @type {string} - * @memberof GetFuturesAggregates200Response + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'status'?: string; -} -/** - * - * @export - * @interface GetFuturesAggregates200ResponseResultsInner - */ -export interface GetFuturesAggregates200ResponseResultsInner { + 'processed_date'?: string; /** - * The last price within the timeframe. - * @type {number} - * @memberof GetFuturesAggregates200ResponseResultsInner + * Indicates whether the product is an Exchange-Traded Note (\'etn\') or an Exchange-Traded Fund (\'etf\'). + * @type {string} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'close'?: number; + 'product_type': string; /** - * The total dollar volume of the transactions that occurred within the timeframe. + * Put/call ratio for options on the ETF. * @type {number} - * @memberof GetFuturesAggregates200ResponseResultsInner + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'dollar_volume'?: number; + 'put_call_ratio'?: number; /** - * The highest price within the timeframe. + * Put options volume. * @type {number} - * @memberof GetFuturesAggregates200ResponseResultsInner + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'high'?: number; + 'put_volume'?: number; /** - * The lowest price within the timeframe. - * @type {number} - * @memberof GetFuturesAggregates200ResponseResultsInner + * The geographic region or area of the world where the ETF concentrates its investments. + * @type {string} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'low'?: number; + 'region'?: string; /** - * The opening price within the timeframe. + * Sector exposure breakdown of the ETF. + * @type {Array} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner + */ + 'sector_exposure'?: Array; + /** + * Short interest in the ETF. * @type {number} - * @memberof GetFuturesAggregates200ResponseResultsInner + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'open'?: number; + 'short_interest'?: number; /** - * Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format. + * The subadvisor of the ETF, if applicable. * @type {string} - * @memberof GetFuturesAggregates200ResponseResultsInner + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'session_end_date'?: string; + 'subadvisor'?: string; /** - * The price the contract would have cost to settle for this session. - * @type {number} - * @memberof GetFuturesAggregates200ResponseResultsInner + * Sub-industry exposure breakdown of the ETF. + * @type {Array} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'settlement_price'?: number; + 'subindustry_exposure'?: Array; /** - * The ticker for the contract. + * The tax structure of the ETF, determining whether investors receive 1099 or K1 tax forms (RIC, Partnership, or UIT). * @type {string} - * @memberof GetFuturesAggregates200ResponseResultsInner + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'ticker'?: string; + 'tax_classification'?: string; /** - * The number of transactions that occurred within the timeframe. + * The total annual expense ratio of the ETF, including all fees and costs passed on to investors. * @type {number} - * @memberof GetFuturesAggregates200ResponseResultsInner + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'transaction_count'?: number; + 'total_expenses'?: number; /** - * The number of contracts that traded within the timeframe. - * @type {number} - * @memberof GetFuturesAggregates200ResponseResultsInner + * The transfer agent for the ETF. + * @type {string} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'volume'?: number; + 'transfer_agent'?: string; /** - * The timestamp of the beginning of the candlestick’s aggregation window. - * @type {number} - * @memberof GetFuturesAggregates200ResponseResultsInner + * The trustee of the ETF. + * @type {string} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInner */ - 'window_start'?: number; + 'trustee'?: string; } /** * * @export - * @interface GetFuturesContractDetails200Response + * @interface GetEtfGlobalV1Profiles200ResponseResultsInnerCouponExposureInner */ -export interface GetFuturesContractDetails200Response { +export interface GetEtfGlobalV1Profiles200ResponseResultsInnerCouponExposureInner { /** - * A unique identifier for this request. + * * @type {string} - * @memberof GetFuturesContractDetails200Response + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInnerCouponExposureInner */ - 'request_id'?: string; + 'key': string; /** * - * @type {GetFuturesContracts200ResponseResultsInner} - * @memberof GetFuturesContractDetails200Response - */ - 'results'?: GetFuturesContracts200ResponseResultsInner; - /** - * The status of this request\'s response. - * @type {string} - * @memberof GetFuturesContractDetails200Response + * @type {number} + * @memberof GetEtfGlobalV1Profiles200ResponseResultsInnerCouponExposureInner */ - 'status'?: string; + 'value': number; } /** * * @export - * @interface GetFuturesContracts200Response + * @interface GetEtfGlobalV1Taxonomies200Response */ -export interface GetFuturesContracts200Response { +export interface GetEtfGlobalV1Taxonomies200Response { /** - * If present, this value can be used to fetch the next page of data. + * If present, this value can be used to fetch the next page. * @type {string} - * @memberof GetFuturesContracts200Response + * @memberof GetEtfGlobalV1Taxonomies200Response */ 'next_url'?: string; /** - * A unique identifier for this request. + * A request id assigned by the server. * @type {string} - * @memberof GetFuturesContracts200Response + * @memberof GetEtfGlobalV1Taxonomies200Response */ - 'request_id'?: string; + 'request_id': string; /** - * - * @type {Array} - * @memberof GetFuturesContracts200Response + * The results for this request. + * @type {Array} + * @memberof GetEtfGlobalV1Taxonomies200Response */ - 'results'?: Array; + 'results': Array; /** * The status of this request\'s response. * @type {string} - * @memberof GetFuturesContracts200Response + * @memberof GetEtfGlobalV1Taxonomies200Response */ - 'status'?: string; + 'status': GetEtfGlobalV1Taxonomies200ResponseStatusEnum; } + +/** + * @export + * @enum {string} + */ +export enum GetEtfGlobalV1Taxonomies200ResponseStatusEnum { + Ok = 'OK' +} + /** * * @export - * @interface GetFuturesContracts200ResponseResultsInner + * @interface GetEtfGlobalV1Taxonomies200ResponseResultsInner */ -export interface GetFuturesContracts200ResponseResultsInner { +export interface GetEtfGlobalV1Taxonomies200ResponseResultsInner { /** - * Whether or not this contract was tradeable at the given point-in-time specified in the \'as_of\' attribute (a contract was active if the given day was after the \'first_trade_date\' and before the \'last_trade_date\'). - * @type {boolean} - * @memberof GetFuturesContracts200ResponseResultsInner + * The primary type of assets held by the ETF, such as equities, bonds, commodities, or other securities. + * @type {string} + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'active'?: boolean; + 'asset_class'?: string; /** - * The point-in-time date for the given contract - e.g. if \'as_of\' is set to 2021-04-25, then the data retrieved describes the contract(s) as of 2021-04-25. + * The broad investment category that describes the ETF\'s investment focus and strategy. * @type {string} - * @memberof GetFuturesContracts200ResponseResultsInner + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'as_of'?: string; + 'category'?: string; /** - * The number of days until this contract matures (since the point-in-time date). Note that the absence of this field means there are 0 days until maturity. - * @type {number} - * @memberof GetFuturesContracts200ResponseResultsInner + * The stock ticker symbol used to identify this ETF product on exchanges. + * @type {string} + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'days_to_maturity'?: number; + 'composite_ticker'?: string; /** - * The date on which this contract first became tradeable. + * The specific country focus of the ETF, if applicable. * @type {string} - * @memberof GetFuturesContracts200ResponseResultsInner + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'first_trade_date'?: string; + 'country'?: string; /** - * The date on which this contract last became tradeable. + * Credit quality rating for fixed income ETFs. * @type {string} - * @memberof GetFuturesContracts200ResponseResultsInner + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'last_trade_date'?: string; + 'credit_quality_rating'?: string; /** - * This field provides the calendar month reflected in the instrument symbol. For futures spreads and options spreads, this field contains the first leg\'s calendar month reflected in the instrument symbol. For daily products, this tag contains the full calendar date (YYYYMMDD) as reflected in the instrument symbol. + * The official name and description of the ETF product. * @type {string} - * @memberof GetFuturesContracts200ResponseResultsInner + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'maturity'?: string; + 'description'?: string; /** - * The maximum order quantity for this contract. - * @type {number} - * @memberof GetFuturesContracts200ResponseResultsInner + * The economic development classification of the markets the ETF invests in, such as developed, emerging, or frontier markets. + * @type {string} + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'max_order_quantity'?: number; + 'development_class'?: string; /** - * The minimum order quantity for this contract. - * @type {number} - * @memberof GetFuturesContracts200ResponseResultsInner + * The duration characteristics for fixed income ETFs. + * @type {string} + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'min_order_quantity'?: number; + 'duration'?: string; /** - * The name of the contract. + * The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. * @type {string} - * @memberof GetFuturesContracts200ResponseResultsInner + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'name'?: string; + 'effective_date'?: string; /** - * The unique identifier for the product to which this contract belongs. + * Environmental, Social, and Governance characteristics. * @type {string} - * @memberof GetFuturesContracts200ResponseResultsInner + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'product_code': string; + 'esg'?: string; /** - * The final settlement date for the contract. + * The mechanism used to achieve exposure. * @type {string} - * @memberof GetFuturesContracts200ResponseResultsInner + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'settlement_date'?: string; + 'exposure_mechanism'?: string; /** - * The settlement tick size for this contract. - * @type {number} - * @memberof GetFuturesContracts200ResponseResultsInner + * Factor exposure characteristics of the ETF. + * @type {string} + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'settlement_tick_size'?: number; + 'factor'?: string; /** - * The spread tick size for this contract. - * @type {number} - * @memberof GetFuturesContracts200ResponseResultsInner + * The specific investment focus or exposure that the ETF provides, such as sector, geography, or investment style. + * @type {string} + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'spread_tick_size'?: number; + 'focus'?: string; /** - * The unique identifier for the contract, typically consisting of the product code and expiration date. + * The frequency of hedge reset, if applicable. * @type {string} - * @memberof GetFuturesContracts200ResponseResultsInner + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'ticker': string; + 'hedge_reset'?: string; /** - * The tick size for this contract. - * @type {number} - * @memberof GetFuturesContracts200ResponseResultsInner + * How frequently holdings are disclosed. + * @type {string} + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'trade_tick_size'?: number; + 'holdings_disclosure_frequency'?: string; /** - * The trading venue (MIC) for the exchange on which this contract trades. + * The date when this ETF was first launched and became available for trading. * @type {string} - * @memberof GetFuturesContracts200ResponseResultsInner + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'trading_venue': string; + 'inception_date'?: string; /** - * The type of contract, one of \"single\" or \"combo\". + * The International Securities Identification Number, a global standard code for uniquely identifying this ETF worldwide. * @type {string} - * @memberof GetFuturesContracts200ResponseResultsInner + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'type': string; -} -/** - * - * @export - * @interface GetFuturesDailySchedules200Response - */ -export interface GetFuturesDailySchedules200Response { + 'isin'?: string; /** - * The URL for the next page of results. + * The financial institution or fund company that created and sponsors this ETF. * @type {string} - * @memberof GetFuturesDailySchedules200Response + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'next_url'?: string; + 'issuer'?: string; /** - * The unique identifier for this request. + * The frequency of leverage reset, if applicable. * @type {string} - * @memberof GetFuturesDailySchedules200Response + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'request_id'?: string; + 'leverage_reset'?: string; /** - * A list of schedules for each product. - * @type {Array} - * @memberof GetFuturesDailySchedules200Response + * Indicates whether the ETF uses leverage to amplify returns (\'leveraged\'), or does not use leverage (\'unleveraged\'). + * @type {string} + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'results'?: Array; + 'leverage_style': string; /** - * The status of the response. + * The leverage multiplier applied by the ETF, where positive numbers indicate leveraged exposure and negative numbers indicate inverse exposure. + * @type {number} + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner + */ + 'levered_amount'?: number; + /** + * Defines whether an ETF is considered active under SEC rules, with managers making investment decisions, or passive, tracking an index. * @type {string} - * @memberof GetFuturesDailySchedules200Response + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'status'?: string; -} -/** - * - * @export - * @interface GetFuturesMarketStatuses200Response - */ -export interface GetFuturesMarketStatuses200Response { + 'management_classification': string; /** - * If present, this value can be used to fetch the next page of data. + * Indicates whether an ETF is managed actively or passively, and the level of transparency or replication method used. * @type {string} - * @memberof GetFuturesMarketStatuses200Response + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'next_url'?: string; + 'management_style'?: string; /** - * A unique identifier for this request. + * The maturity profile for fixed income ETFs. * @type {string} - * @memberof GetFuturesMarketStatuses200Response + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'request_id'?: string; + 'maturity'?: string; /** - * - * @type {Array} - * @memberof GetFuturesMarketStatuses200Response + * The primary investment objective of the ETF. + * @type {string} + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'results'?: Array; + 'objective'?: string; /** - * The status of this request\'s response. + * The main index or benchmark that this ETF is designed to track or replicate. * @type {string} - * @memberof GetFuturesMarketStatuses200Response + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'status'?: string; + 'primary_benchmark'?: string; /** - * An RFC3339 timestamp representing the moment at which the market statuses were evaluated. + * The date showing when ETF Global received and processed the data. * @type {string} - * @memberof GetFuturesMarketStatuses200Response + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'timestamp'?: string; -} -/** - * - * @export - * @interface GetFuturesMarketStatuses200ResponseResultsInner - */ -export interface GetFuturesMarketStatuses200ResponseResultsInner { + 'processed_date'?: string; /** - * The current status of the market. + * Indicates whether the product is an Exchange-Traded Note (\'etn\') or an Exchange-Traded Fund (\'etf\'). * @type {string} - * @memberof GetFuturesMarketStatuses200ResponseResultsInner + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'market_status': GetFuturesMarketStatuses200ResponseResultsInnerMarketStatusEnum; + 'product_type': string; /** - * The product code for the product. + * How frequently the ETF rebalances its holdings. * @type {string} - * @memberof GetFuturesMarketStatuses200ResponseResultsInner + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'product_code': string; + 'rebalance_frequency'?: string; /** - * The trading venue (MIC) for the exchange on which the corresponding product trades. + * How frequently the index is reconstituted. * @type {string} - * @memberof GetFuturesMarketStatuses200ResponseResultsInner + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'trading_venue'?: string; -} - -/** - * @export - * @enum {string} - */ -export enum GetFuturesMarketStatuses200ResponseResultsInnerMarketStatusEnum { - PreOpen = 'pre_open', - Open = 'open', - Close = 'close', - Pause = 'pause', - PostClosePreOpen = 'post_close_pre_open' -} - -/** - * - * @export - * @interface GetFuturesProductDetails200Response - */ -export interface GetFuturesProductDetails200Response { + 'reconstitution_frequency'?: string; /** - * A unique identifier for this request. + * The geographic region or area of the world where the ETF concentrates its investments. * @type {string} - * @memberof GetFuturesProductDetails200Response + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'request_id'?: string; + 'region'?: string; /** - * - * @type {GetFuturesProducts200ResponseResultsInner} - * @memberof GetFuturesProductDetails200Response + * The secondary investment objective, if applicable. + * @type {string} + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'results'?: GetFuturesProducts200ResponseResultsInner; + 'secondary_objective'?: string; /** - * The status of this request\'s response. + * The methodology used to select securities. * @type {string} - * @memberof GetFuturesProductDetails200Response + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'status'?: string; -} -/** - * - * @export - * @interface GetFuturesProductSchedules200Response - */ -export interface GetFuturesProductSchedules200Response { + 'selection_methodology'?: string; /** - * An optional error message for failed requests when available. + * The universe from which securities are selected. * @type {string} - * @memberof GetFuturesProductSchedules200Response + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'error'?: string; + 'selection_universe'?: string; /** - * If present, this value can be used to fetch the next page of data. + * The strategic investment focus of the ETF. * @type {string} - * @memberof GetFuturesProductSchedules200Response + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'next_url'?: string; + 'strategic_focus'?: string; /** - * The unique identifier for the request. + * The targeted investment focus of the ETF. * @type {string} - * @memberof GetFuturesProductSchedules200Response + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'request_id'?: string; + 'targeted_focus'?: string; /** - * The list of schedules for the specified product. - * @type {Array} - * @memberof GetFuturesProductSchedules200Response + * The tax structure of the ETF, determining whether investors receive 1099 or K1 tax forms (RIC, Partnership, or UIT). + * @type {string} + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'results'?: Array; + 'tax_classification'?: string; /** - * The status of the response. + * A unique identifier code that identifies this ETF in US markets. * @type {string} - * @memberof GetFuturesProductSchedules200Response + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner */ - 'status'?: string; + 'us_code'?: string; + /** + * The methodology used to weight holdings. + * @type {string} + * @memberof GetEtfGlobalV1Taxonomies200ResponseResultsInner + */ + 'weighting_methodology'?: string; } /** * * @export - * @interface GetFuturesProductSchedules200ResponseResultsInner + * @interface GetEvents200Response */ -export interface GetFuturesProductSchedules200ResponseResultsInner { - /** - * The product code for the futures product to which this schedule applies. - * @type {string} - * @memberof GetFuturesProductSchedules200ResponseResultsInner - */ - 'product_code'?: string; +export interface GetEvents200Response { /** - * The name of the futures product to which this schedule applies. + * A request id assigned by the server. * @type {string} - * @memberof GetFuturesProductSchedules200ResponseResultsInner + * @memberof GetEvents200Response */ - 'product_name'?: string; + 'request_id'?: string; /** * - * @type {Array} - * @memberof GetFuturesProductSchedules200ResponseResultsInner - */ - 'schedule'?: Array; - /** - * The date on which the schedule\'s trading day ended (sometimes referred to as trading date) formatted as `YYYY-MM-DD`. Note that although there is no time component on this attribute, the day refers to Central Time. - * @type {string} - * @memberof GetFuturesProductSchedules200ResponseResultsInner + * @type {GetEvents200ResponseResults} + * @memberof GetEvents200Response */ - 'session_end_date'?: string; + 'results'?: GetEvents200ResponseResults; /** - * The trading venue (MIC) for the exchange on which this schedule\'s product trades. + * The status of this request\'s response. * @type {string} - * @memberof GetFuturesProductSchedules200ResponseResultsInner + * @memberof GetEvents200Response */ - 'trading_venue'?: string; + 'status'?: string; } /** - * + * Contains the requested event data for the specified ticker. * @export - * @interface GetFuturesProductSchedules200ResponseResultsInnerScheduleInner + * @interface GetEvents200ResponseResults */ -export interface GetFuturesProductSchedules200ResponseResultsInnerScheduleInner { +export interface GetEvents200ResponseResults { /** - * The market event for this schedule. - * @type {string} - * @memberof GetFuturesProductSchedules200ResponseResultsInnerScheduleInner + * An array of event containing the requested data. + * @type {Array} + * @memberof GetEvents200ResponseResults */ - 'event'?: GetFuturesProductSchedules200ResponseResultsInnerScheduleInnerEventEnum; + 'events'?: Array; /** - * The timestamp for this market event in Central Time. + * The name of the asset. * @type {string} - * @memberof GetFuturesProductSchedules200ResponseResultsInnerScheduleInner + * @memberof GetEvents200ResponseResults */ - 'timestamp'?: string; + 'name'?: string; } - /** - * @export - * @enum {string} - */ -export enum GetFuturesProductSchedules200ResponseResultsInnerScheduleInnerEventEnum { - PreOpen = 'pre_open', - Open = 'open', - Close = 'close', - Pause = 'pause', - PostClosePreOpen = 'post_close_pre_open' -} + * @type GetEvents200ResponseResultsEventsInner + * @export + */ +export type GetEvents200ResponseResultsEventsInner = GetEvents200ResponseResultsEventsInnerOneOf; /** * * @export - * @interface GetFuturesProducts200Response + * @interface GetEvents200ResponseResultsEventsInnerOneOf */ -export interface GetFuturesProducts200Response { +export interface GetEvents200ResponseResultsEventsInnerOneOf { /** - * If present, this value can be used to fetch the next page of data. + * The date the event took place * @type {string} - * @memberof GetFuturesProducts200Response + * @memberof GetEvents200ResponseResultsEventsInnerOneOf */ - 'next_url'?: string; + 'date': string; /** - * A unique identifier for this request. + * The type of historical event for the asset * @type {string} - * @memberof GetFuturesProducts200Response + * @memberof GetEvents200ResponseResultsEventsInnerOneOf */ - 'request_id'?: string; + 'event_type': string; /** * - * @type {Array} - * @memberof GetFuturesProducts200Response + * @type {GetEvents200ResponseResultsEventsInnerOneOfTickerChange} + * @memberof GetEvents200ResponseResultsEventsInnerOneOf */ - 'results'?: Array; + 'ticker_change'?: GetEvents200ResponseResultsEventsInnerOneOfTickerChange; +} +/** + * Details about a ticker change + * @export + * @interface GetEvents200ResponseResultsEventsInnerOneOfTickerChange + */ +export interface GetEvents200ResponseResultsEventsInnerOneOfTickerChange { /** - * The status of this request\'s response. + * A ticker symbol * @type {string} - * @memberof GetFuturesProducts200Response + * @memberof GetEvents200ResponseResultsEventsInnerOneOfTickerChange */ - 'status'?: string; + 'ticker'?: string; } /** * * @export - * @interface GetFuturesProducts200ResponseResultsInner + * @interface GetFedV1Inflation200Response */ -export interface GetFuturesProducts200ResponseResultsInner { +export interface GetFedV1Inflation200Response { /** - * The point-in-time date for the given product - e.g. if \'as_of\' is set to 2024-11-05, then these were the details for this product on that day. + * If present, this value can be used to fetch the next page. * @type {string} - * @memberof GetFuturesProducts200ResponseResultsInner + * @memberof GetFedV1Inflation200Response */ - 'as_of'?: string; + 'next_url'?: string; /** - * The asset class to which the product belongs. + * A request id assigned by the server. * @type {string} - * @memberof GetFuturesProducts200ResponseResultsInner + * @memberof GetFedV1Inflation200Response */ - 'asset_class'?: string; + 'request_id': string; /** - * The asset sub-class to which the product belongs. - * @type {string} - * @memberof GetFuturesProducts200ResponseResultsInner + * The results for this request. + * @type {Array} + * @memberof GetFedV1Inflation200Response */ - 'asset_sub_class'?: string; + 'results': Array; /** - * The clearing channel for this product. Indicates whether the product can be cleared only through exchanges or through both exchanges and over-the-counter. + * The status of this request\'s response. * @type {string} - * @memberof GetFuturesProducts200ResponseResultsInner + * @memberof GetFedV1Inflation200Response */ - 'clearing_channel'?: GetFuturesProducts200ResponseResultsInnerClearingChannelEnum; + 'status': GetFedV1Inflation200ResponseStatusEnum; +} + +/** + * @export + * @enum {string} + */ +export enum GetFedV1Inflation200ResponseStatusEnum { + Ok = 'OK' +} + +/** + * + * @export + * @interface GetFedV1Inflation200ResponseResultsInner + */ +export interface GetFedV1Inflation200ResponseResultsInner { /** - * The date and time at which this product was last updated. - * @type {string} - * @memberof GetFuturesProducts200ResponseResultsInner + * Consumer Price Index (CPI) for All Urban Consumers — a standard measure of headline inflation based on a fixed basket of goods and services, not seasonally adjusted. + * @type {number} + * @memberof GetFedV1Inflation200ResponseResultsInner */ - 'last_updated'?: string; + 'cpi'?: number; /** - * The full name of the product. - * @type {string} - * @memberof GetFuturesProducts200ResponseResultsInner + * Core Consumer Price Index — the CPI excluding food and energy, used to understand underlying inflation trends without short-term volatility. + * @type {number} + * @memberof GetFedV1Inflation200ResponseResultsInner */ - 'name'?: string; + 'cpi_core'?: number; /** - * The quoted price for this product. - * @type {string} - * @memberof GetFuturesProducts200ResponseResultsInner + * Year-over-year percentage change in the headline CPI — the most commonly cited inflation rate in public discourse and economic policy. + * @type {number} + * @memberof GetFedV1Inflation200ResponseResultsInner */ - 'price_quotation'?: string; + 'cpi_year_over_year'?: number; /** - * The unique identifier for the product. + * Calendar date of the observation (YYYY‑MM‑DD). * @type {string} - * @memberof GetFuturesProducts200ResponseResultsInner + * @memberof GetFedV1Inflation200ResponseResultsInner */ - 'product_code': string; + 'date'?: string; /** - * The sector to which the product belongs. - * @type {string} - * @memberof GetFuturesProducts200ResponseResultsInner + * Personal Consumption Expenditures (PCE) Price Index — a broader measure of inflation used by the Federal Reserve, reflecting actual consumer spending patterns and updated basket weights. + * @type {number} + * @memberof GetFedV1Inflation200ResponseResultsInner */ - 'sector'?: string; + 'pce'?: number; /** - * The currency in which this product settles. - * @type {string} - * @memberof GetFuturesProducts200ResponseResultsInner + * Core PCE Price Index — excludes food and energy prices from the PCE index, and is the Fed\'s preferred measure of underlying inflation. + * @type {number} + * @memberof GetFedV1Inflation200ResponseResultsInner */ - 'settlement_currency_code'?: string; + 'pce_core'?: number; /** - * The method of settlement for this product (Financially Settled or Deliverable). - * @type {string} - * @memberof GetFuturesProducts200ResponseResultsInner + * Nominal Personal Consumption Expenditures — total dollar value of consumer spending in the U.S. economy, reported in billions of dollars and not adjusted for inflation. + * @type {number} + * @memberof GetFedV1Inflation200ResponseResultsInner */ - 'settlement_method'?: string; + 'pce_spending'?: number; +} +/** + * + * @export + * @interface GetFedV1InflationExpectations200Response + */ +export interface GetFedV1InflationExpectations200Response { /** - * The type of settlement for this product. + * If present, this value can be used to fetch the next page. * @type {string} - * @memberof GetFuturesProducts200ResponseResultsInner + * @memberof GetFedV1InflationExpectations200Response */ - 'settlement_type'?: string; + 'next_url'?: string; /** - * The sub-sector to which the product belongs. + * A request id assigned by the server. * @type {string} - * @memberof GetFuturesProducts200ResponseResultsInner + * @memberof GetFedV1InflationExpectations200Response */ - 'sub_sector'?: string; + 'request_id': string; /** - * The currency in which this product trades. - * @type {string} - * @memberof GetFuturesProducts200ResponseResultsInner + * The results for this request. + * @type {Array} + * @memberof GetFedV1InflationExpectations200Response */ - 'trade_currency_code'?: string; + 'results': Array; /** - * The trading venue (MIC) for the exchange on which this contract trades. + * The status of this request\'s response. * @type {string} - * @memberof GetFuturesProducts200ResponseResultsInner - */ - 'trading_venue'?: string; - /** - * The type of product, one of \"single\" or \"combo\". - * @type {string} - * @memberof GetFuturesProducts200ResponseResultsInner - */ - 'type'?: string; - /** - * The unit of measure for this product. - * @type {string} - * @memberof GetFuturesProducts200ResponseResultsInner - */ - 'unit_of_measure'?: string; - /** - * The quantity of the unit of measure for this product. - * @type {number} - * @memberof GetFuturesProducts200ResponseResultsInner + * @memberof GetFedV1InflationExpectations200Response */ - 'unit_of_measure_quantity'?: number; + 'status': GetFedV1InflationExpectations200ResponseStatusEnum; } /** * @export * @enum {string} */ -export enum GetFuturesProducts200ResponseResultsInnerClearingChannelEnum { - ExchangeOnly = 'exchange_only', - ExchangeAndOtc = 'exchange_and_otc' +export enum GetFedV1InflationExpectations200ResponseStatusEnum { + Ok = 'OK' } /** * * @export - * @interface GetFuturesQuotes200Response + * @interface GetFedV1InflationExpectations200ResponseResultsInner */ -export interface GetFuturesQuotes200Response { - /** - * If present, this value can be used to fetch the next page of data. - * @type {string} - * @memberof GetFuturesQuotes200Response - */ - 'next_url'?: string; - /** - * - * @type {Array} - * @memberof GetFuturesQuotes200Response - */ - 'results'?: Array; +export interface GetFedV1InflationExpectations200ResponseResultsInner { /** - * The status of this request\'s response. + * Calendar date of the observation (YYYY‑MM‑DD). * @type {string} - * @memberof GetFuturesQuotes200Response + * @memberof GetFedV1InflationExpectations200ResponseResultsInner */ - 'status': string; -} -/** - * - * @export - * @interface GetFuturesQuotes200ResponseResultsInner - */ -export interface GetFuturesQuotes200ResponseResultsInner { + 'date'?: string; /** - * The ask price is expressed per unit of the underlying asset, and you apply the contract multiplier to get the full contract value. + * 5-Year, 5-Year Forward Inflation Expectation Rate — the market\'s expectation of average annual inflation for the 5-year period beginning 5 years from now, based on the spread between forward nominal and real yields. * @type {number} - * @memberof GetFuturesQuotes200ResponseResultsInner + * @memberof GetFedV1InflationExpectations200ResponseResultsInner */ - 'ask_price'?: number; + 'forward_years_5_to_10'?: number; /** - * The quote size represents the number of futures contracts available at the given ask price. + * 10-Year Breakeven Inflation Rate — the market\'s expectation of average annual inflation over the next 10 years, based on the spread between 10-year nominal Treasury yields and 10-year TIPS yields. * @type {number} - * @memberof GetFuturesQuotes200ResponseResultsInner + * @memberof GetFedV1InflationExpectations200ResponseResultsInner */ - 'ask_size'?: number; + 'market_10_year'?: number; /** - * The time when the ask price was submitted to the exchange. + * 5-Year Breakeven Inflation Rate — the market\'s expectation of average annual inflation over the next 5 years, based on the spread between 5-year nominal Treasury yields and 5-year TIPS yields. * @type {number} - * @memberof GetFuturesQuotes200ResponseResultsInner + * @memberof GetFedV1InflationExpectations200ResponseResultsInner */ - 'ask_timestamp'?: number; + 'market_5_year'?: number; /** - * The bid price is expressed per unit of the underlying asset, and you apply the contract multiplier to get the full contract value. + * The Cleveland Fed’s 10-year inflation expectations data estimated expected inflation, risk premiums, and the real interest rate using a model based on Treasury yields, inflation data, swaps, and surveys. * @type {number} - * @memberof GetFuturesQuotes200ResponseResultsInner + * @memberof GetFedV1InflationExpectations200ResponseResultsInner */ - 'bid_price'?: number; + 'model_10_year'?: number; /** - * The quote size represents the number of futures contracts available at the given bid price. + * The Cleveland Fed’s 1-year inflation expectations data estimated expected inflation, risk premiums, and the real interest rate using a model based on Treasury yields, inflation data, swaps, and surveys. * @type {number} - * @memberof GetFuturesQuotes200ResponseResultsInner + * @memberof GetFedV1InflationExpectations200ResponseResultsInner */ - 'bid_size'?: number; + 'model_1_year'?: number; /** - * The time when the bid price was submitted to the exchange. + * The Cleveland Fed’s 30-year inflation expectations data estimated expected inflation, risk premiums, and the real interest rate using a model based on Treasury yields, inflation data, swaps, and surveys. * @type {number} - * @memberof GetFuturesQuotes200ResponseResultsInner - */ - 'bid_timestamp'?: number; - /** - * Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format. - * @type {string} - * @memberof GetFuturesQuotes200ResponseResultsInner - */ - 'session_end_date'?: string; - /** - * The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract). - * @type {string} - * @memberof GetFuturesQuotes200ResponseResultsInner + * @memberof GetFedV1InflationExpectations200ResponseResultsInner */ - 'ticker'?: string; + 'model_30_year'?: number; /** - * The time when the quote was generated at the exchange to nanosecond precision. + * The Cleveland Fed’s 5-year inflation expectations data estimated expected inflation, risk premiums, and the real interest rate using a model based on Treasury yields, inflation data, swaps, and surveys. * @type {number} - * @memberof GetFuturesQuotes200ResponseResultsInner + * @memberof GetFedV1InflationExpectations200ResponseResultsInner */ - 'timestamp'?: number; + 'model_5_year'?: number; } /** * * @export - * @interface GetFuturesTrades200Response + * @interface GetFedV1TreasuryYields200Response */ -export interface GetFuturesTrades200Response { +export interface GetFedV1TreasuryYields200Response { /** - * If present, this value can be used to fetch the next page of data. + * If present, this value can be used to fetch the next page. * @type {string} - * @memberof GetFuturesTrades200Response + * @memberof GetFedV1TreasuryYields200Response */ 'next_url'?: string; /** - * - * @type {Array} - * @memberof GetFuturesTrades200Response + * A request id assigned by the server. + * @type {string} + * @memberof GetFedV1TreasuryYields200Response */ - 'results'?: Array; + 'request_id': string; + /** + * The results for this request. + * @type {Array} + * @memberof GetFedV1TreasuryYields200Response + */ + 'results': Array; /** * The status of this request\'s response. * @type {string} - * @memberof GetFuturesTrades200Response + * @memberof GetFedV1TreasuryYields200Response */ - 'status': string; + 'status': GetFedV1TreasuryYields200ResponseStatusEnum; +} + +/** + * @export + * @enum {string} + */ +export enum GetFedV1TreasuryYields200ResponseStatusEnum { + Ok = 'OK' } + /** * * @export - * @interface GetFuturesTrades200ResponseResultsInner + * @interface GetFedV1TreasuryYields200ResponseResultsInner */ -export interface GetFuturesTrades200ResponseResultsInner { +export interface GetFedV1TreasuryYields200ResponseResultsInner { /** - * The price of the trade. This is the actual dollar value per whole contract of this trade. A trade of 100 contracts with a price of $2.00 would be worth a total dollar value of $200.00. + * Calendar date of the yield observation (YYYY-MM-DD). + * @type {string} + * @memberof GetFedV1TreasuryYields200ResponseResultsInner + */ + 'date'?: string; + /** + * Market Yield on U.S. Treasury Securities at 10-Year Constant Maturity, Quoted on an Investment Basis * @type {number} - * @memberof GetFuturesTrades200ResponseResultsInner + * @memberof GetFedV1TreasuryYields200ResponseResultsInner */ - 'price': number; + 'yield_10_year'?: number; /** - * Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format. - * @type {string} - * @memberof GetFuturesTrades200ResponseResultsInner + * Market Yield on U.S. Treasury Securities at 1-Month Constant Maturity, Quoted on an Investment Basis + * @type {number} + * @memberof GetFedV1TreasuryYields200ResponseResultsInner */ - 'session_end_date'?: string; + 'yield_1_month'?: number; /** - * The total number of contracts exchanged between buyers and sellers on a given trade. + * Market Yield on U.S. Treasury Securities at 1-Year Constant Maturity, Quoted on an Investment Basis * @type {number} - * @memberof GetFuturesTrades200ResponseResultsInner + * @memberof GetFedV1TreasuryYields200ResponseResultsInner */ - 'size': number; + 'yield_1_year'?: number; /** - * ticker of the trade - * @type {string} - * @memberof GetFuturesTrades200ResponseResultsInner + * Market Yield on U.S. Treasury Securities at 20-Year Constant Maturity, Quoted on an Investment Basis + * @type {number} + * @memberof GetFedV1TreasuryYields200ResponseResultsInner */ - 'ticker'?: string; + 'yield_20_year'?: number; /** - * The time when the trade was generated at the exchange to nanosecond precision. + * Market Yield on U.S. Treasury Securities at 2-Year Constant Maturity, Quoted on an Investment Basis * @type {number} - * @memberof GetFuturesTrades200ResponseResultsInner + * @memberof GetFedV1TreasuryYields200ResponseResultsInner */ - 'timestamp'?: number; -} -/** - * - * @export - * @interface GetGroupedCryptoAggregates200Response - */ -export interface GetGroupedCryptoAggregates200Response { + 'yield_2_year'?: number; /** - * Whether or not this response was adjusted for splits. - * @type {boolean} - * @memberof GetGroupedCryptoAggregates200Response + * Market Yield on U.S. Treasury Securities at 30-Year Constant Maturity, Quoted on an Investment Basis + * @type {number} + * @memberof GetFedV1TreasuryYields200ResponseResultsInner */ - 'adjusted': boolean; + 'yield_30_year'?: number; /** - * The number of aggregates (minute or day) used to generate the response. + * Market Yield on U.S. Treasury Securities at 3-Month Constant Maturity, Quoted on an Investment Basis * @type {number} - * @memberof GetGroupedCryptoAggregates200Response + * @memberof GetFedV1TreasuryYields200ResponseResultsInner */ - 'queryCount': number; + 'yield_3_month'?: number; /** - * A request id assigned by the server. - * @type {string} - * @memberof GetGroupedCryptoAggregates200Response + * Market Yield on U.S. Treasury Securities at 3-Year Constant Maturity, Quoted on an Investment Basis + * @type {number} + * @memberof GetFedV1TreasuryYields200ResponseResultsInner */ - 'request_id': string; + 'yield_3_year'?: number; /** - * The total number of results for this request. + * Market Yield on U.S. Treasury Securities at 5-Year Constant Maturity, Quoted on an Investment Basis * @type {number} - * @memberof GetGroupedCryptoAggregates200Response + * @memberof GetFedV1TreasuryYields200ResponseResultsInner */ - 'resultsCount': number; + 'yield_5_year'?: number; /** - * The status of this request\'s response. - * @type {string} - * @memberof GetGroupedCryptoAggregates200Response + * Market Yield on U.S. Treasury Securities at 6-Month Constant Maturity, Quoted on an Investment Basis + * @type {number} + * @memberof GetFedV1TreasuryYields200ResponseResultsInner */ - 'status': string; + 'yield_6_month'?: number; /** - * An array of results containing the requested data. - * @type {Array} - * @memberof GetGroupedCryptoAggregates200Response + * Market Yield on U.S. Treasury Securities at 7-Year Constant Maturity, Quoted on an Investment Basis + * @type {number} + * @memberof GetFedV1TreasuryYields200ResponseResultsInner */ - 'results'?: Array; + 'yield_7_year'?: number; } /** * * @export - * @interface GetGroupedCryptoAggregates200ResponseAllOfResultsInner + * @interface GetForexQuotes200Response */ -export interface GetGroupedCryptoAggregates200ResponseAllOfResultsInner { +export interface GetForexQuotes200Response { /** - * The exchange symbol that this item is traded under. + * If present, this value can be used to fetch the next page of data. * @type {string} - * @memberof GetGroupedCryptoAggregates200ResponseAllOfResultsInner + * @memberof GetForexQuotes200Response */ - 'T': string; + 'next_url'?: string; /** - * The close price for the symbol in the given time period. - * @type {number} - * @memberof GetGroupedCryptoAggregates200ResponseAllOfResultsInner + * A request id assigned by the server. + * @type {string} + * @memberof GetForexQuotes200Response */ - 'c': number; + 'request_id'?: string; /** - * The highest price for the symbol in the given time period. - * @type {number} - * @memberof GetGroupedCryptoAggregates200ResponseAllOfResultsInner + * An array of results containing the requested data. + * @type {Array} + * @memberof GetForexQuotes200Response */ - 'h': number; + 'results'?: Array; /** - * The lowest price for the symbol in the given time period. - * @type {number} - * @memberof GetGroupedCryptoAggregates200ResponseAllOfResultsInner + * The status of this request\'s response. + * @type {string} + * @memberof GetForexQuotes200Response */ - 'l': number; + 'status': string; +} +/** + * + * @export + * @interface GetForexQuotes200ResponseResultsInner + */ +export interface GetForexQuotes200ResponseResultsInner { /** - * The number of transactions in the aggregate window. + * The ask exchange ID * @type {number} - * @memberof GetGroupedCryptoAggregates200ResponseAllOfResultsInner + * @memberof GetForexQuotes200ResponseResultsInner */ - 'n'?: number; + 'ask_exchange'?: number; /** - * The open price for the symbol in the given time period. + * The ask price. * @type {number} - * @memberof GetGroupedCryptoAggregates200ResponseAllOfResultsInner + * @memberof GetForexQuotes200ResponseResultsInner */ - 'o': number; + 'ask_price'?: number; /** - * The Unix millisecond timestamp for the end of the aggregate window. + * The bid exchange ID * @type {number} - * @memberof GetGroupedCryptoAggregates200ResponseAllOfResultsInner + * @memberof GetForexQuotes200ResponseResultsInner */ - 't': number; + 'bid_exchange'?: number; /** - * The trading volume of the symbol in the given time period. + * The bid price. * @type {number} - * @memberof GetGroupedCryptoAggregates200ResponseAllOfResultsInner + * @memberof GetForexQuotes200ResponseResultsInner */ - 'v': number; + 'bid_price'?: number; /** - * The volume weighted average price. + * The nanosecond Exchange Unix Timestamp. This is the timestamp of when the quote was generated at the exchange. * @type {number} - * @memberof GetGroupedCryptoAggregates200ResponseAllOfResultsInner + * @memberof GetForexQuotes200ResponseResultsInner */ - 'vw'?: number; + 'participant_timestamp': number; } /** * * @export - * @interface GetGroupedStocksAggregates200Response + * @interface GetForexSnapshotTicker200Response */ -export interface GetGroupedStocksAggregates200Response { - /** - * Whether or not this response was adjusted for splits. - * @type {boolean} - * @memberof GetGroupedStocksAggregates200Response - */ - 'adjusted': boolean; +export interface GetForexSnapshotTicker200Response { /** - * The number of aggregates (minute or day) used to generate the response. - * @type {number} - * @memberof GetGroupedStocksAggregates200Response + * The status of this request\'s response. + * @type {string} + * @memberof GetForexSnapshotTicker200Response */ - 'queryCount': number; + 'status': string; /** * A request id assigned by the server. * @type {string} - * @memberof GetGroupedStocksAggregates200Response + * @memberof GetForexSnapshotTicker200Response */ 'request_id': string; /** - * The total number of results for this request. - * @type {number} - * @memberof GetGroupedStocksAggregates200Response - */ - 'resultsCount': number; - /** - * The status of this request\'s response. - * @type {string} - * @memberof GetGroupedStocksAggregates200Response - */ - 'status': string; - /** - * An array of results containing the requested data. - * @type {Array} - * @memberof GetGroupedStocksAggregates200Response + * + * @type {GetForexSnapshotTicker200ResponseAllOfTicker} + * @memberof GetForexSnapshotTicker200Response */ - 'results'?: Array; + 'ticker'?: GetForexSnapshotTicker200ResponseAllOfTicker; } /** - * + * Contains the requested snapshot data for the specified ticker. * @export - * @interface GetGroupedStocksAggregates200ResponseAllOfResultsInner + * @interface GetForexSnapshotTicker200ResponseAllOfTicker */ -export interface GetGroupedStocksAggregates200ResponseAllOfResultsInner { +export interface GetForexSnapshotTicker200ResponseAllOfTicker { /** - * The exchange symbol that this item is traded under. - * @type {string} - * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner + * + * @type {GetForexSnapshotTickers200ResponseAllOfTickersInnerDay} + * @memberof GetForexSnapshotTicker200ResponseAllOfTicker */ - 'T': string; + 'day': GetForexSnapshotTickers200ResponseAllOfTickersInnerDay; /** - * The close price for the symbol in the given time period. + * Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us. * @type {number} - * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner + * @memberof GetForexSnapshotTicker200ResponseAllOfTicker */ - 'c': number; + 'fmv'?: number; /** - * The highest price for the symbol in the given time period. - * @type {number} - * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner + * + * @type {GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote} + * @memberof GetForexSnapshotTicker200ResponseAllOfTicker */ - 'h': number; + 'lastQuote': GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote; /** - * The lowest price for the symbol in the given time period. - * @type {number} - * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner + * + * @type {GetForexSnapshotTickers200ResponseAllOfTickersInnerMin} + * @memberof GetForexSnapshotTicker200ResponseAllOfTicker */ - 'l': number; + 'min': GetForexSnapshotTickers200ResponseAllOfTickersInnerMin; /** - * The number of transactions in the aggregate window. - * @type {number} - * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner + * + * @type {GetCryptoSnapshotTickers200ResponseAllOfTickersInnerPrevDay} + * @memberof GetForexSnapshotTicker200ResponseAllOfTicker */ - 'n'?: number; + 'prevDay': GetCryptoSnapshotTickers200ResponseAllOfTickersInnerPrevDay; /** - * The open price for the symbol in the given time period. - * @type {number} - * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner + * The exchange symbol that this item is traded under. + * @type {string} + * @memberof GetForexSnapshotTicker200ResponseAllOfTicker */ - 'o': number; + 'ticker': string; /** - * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. - * @type {boolean} - * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner + * The value of the change from the previous day. + * @type {number} + * @memberof GetForexSnapshotTicker200ResponseAllOfTicker */ - 'otc'?: boolean; + 'todaysChange': number; /** - * The Unix millisecond timestamp for the end of the aggregate window. + * The percentage change since the previous day. * @type {number} - * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner + * @memberof GetForexSnapshotTicker200ResponseAllOfTicker */ - 't': number; + 'todaysChangePerc': number; /** - * The trading volume of the symbol in the given time period. + * The last updated timestamp. * @type {number} - * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner + * @memberof GetForexSnapshotTicker200ResponseAllOfTicker */ - 'v': number; + 'updated': number; +} +/** + * + * @export + * @interface GetForexSnapshotTickers200Response + */ +export interface GetForexSnapshotTickers200Response { /** - * The volume weighted average price. - * @type {number} - * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner + * The status of this request\'s response. + * @type {string} + * @memberof GetForexSnapshotTickers200Response */ - 'vw'?: number; + 'status': string; + /** + * An array of snapshot data for the specified tickers. + * @type {Array} + * @memberof GetForexSnapshotTickers200Response + */ + 'tickers'?: Array; } /** * * @export - * @interface GetIndicesOpenClose200Response + * @interface GetForexSnapshotTickers200ResponseAllOfTickersInner */ -export interface GetIndicesOpenClose200Response { +export interface GetForexSnapshotTickers200ResponseAllOfTickersInner { /** - * The close value of the ticker symbol in after hours trading. - * @type {number} - * @memberof GetIndicesOpenClose200Response + * + * @type {GetForexSnapshotTickers200ResponseAllOfTickersInnerDay} + * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInner */ - 'afterHours'?: number; + 'day': GetForexSnapshotTickers200ResponseAllOfTickersInnerDay; /** - * The close value for the symbol in the given time period. + * Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us. * @type {number} - * @memberof GetIndicesOpenClose200Response + * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInner */ - 'close': number; + 'fmv'?: number; /** - * The requested date. - * @type {string} - * @memberof GetIndicesOpenClose200Response + * + * @type {GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote} + * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInner */ - 'from': string; + 'lastQuote': GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote; /** - * The highest value for the symbol in the given time period. - * @type {number} - * @memberof GetIndicesOpenClose200Response + * + * @type {GetForexSnapshotTickers200ResponseAllOfTickersInnerMin} + * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInner */ - 'high': number; + 'min': GetForexSnapshotTickers200ResponseAllOfTickersInnerMin; /** - * The lowest value for the symbol in the given time period. - * @type {number} - * @memberof GetIndicesOpenClose200Response + * + * @type {GetCryptoSnapshotTickers200ResponseAllOfTickersInnerPrevDay} + * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInner */ - 'low': number; + 'prevDay': GetCryptoSnapshotTickers200ResponseAllOfTickersInnerPrevDay; /** - * The open value for the symbol in the given time period. - * @type {number} - * @memberof GetIndicesOpenClose200Response + * The exchange symbol that this item is traded under. + * @type {string} + * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInner */ - 'open': number; + 'ticker': string; /** - * The open value of the ticker symbol in pre-market trading. + * The value of the change from the previous day. * @type {number} - * @memberof GetIndicesOpenClose200Response + * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInner */ - 'preMarket'?: number; + 'todaysChange': number; /** - * The status of this request\'s response. - * @type {string} - * @memberof GetIndicesOpenClose200Response + * The percentage change since the previous day. + * @type {number} + * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInner */ - 'status': string; + 'todaysChangePerc': number; /** - * The exchange symbol that this item is traded under. - * @type {string} - * @memberof GetIndicesOpenClose200Response + * The last updated timestamp. + * @type {number} + * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInner */ - 'symbol': string; + 'updated': number; } /** - * + * The most recent daily bar for this ticker. * @export - * @interface GetIndicesSnapshot200Response + * @interface GetForexSnapshotTickers200ResponseAllOfTickersInnerDay */ -export interface GetIndicesSnapshot200Response { +export interface GetForexSnapshotTickers200ResponseAllOfTickersInnerDay { /** - * If present, this value can be used to fetch the next page of data. - * @type {string} - * @memberof GetIndicesSnapshot200Response + * The close price for the symbol in the given time period. + * @type {number} + * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerDay */ - 'next_url'?: string; + 'c': number; /** - * A request id assigned by the server. - * @type {string} - * @memberof GetIndicesSnapshot200Response + * The highest price for the symbol in the given time period. + * @type {number} + * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerDay */ - 'request_id': string; + 'h': number; /** - * An array of results containing the requested data. - * @type {Array} - * @memberof GetIndicesSnapshot200Response + * The lowest price for the symbol in the given time period. + * @type {number} + * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerDay */ - 'results'?: Array; + 'l': number; /** - * The status of this request\'s response. - * @type {string} - * @memberof GetIndicesSnapshot200Response + * The open price for the symbol in the given time period. + * @type {number} + * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerDay */ - 'status': string; + 'o': number; + /** + * The trading volume of the symbol in the given time period. + * @type {number} + * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerDay + */ + 'v': number; } /** - * + * The most recent quote for this ticker. * @export - * @interface GetIndicesSnapshot200ResponseResultsInner + * @interface GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote */ -export interface GetIndicesSnapshot200ResponseResultsInner { - /** - * The error while looking for this ticker. - * @type {string} - * @memberof GetIndicesSnapshot200ResponseResultsInner - */ - 'error'?: string; +export interface GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote { /** - * The nanosecond timestamp of when this information was updated. + * The ask price. * @type {number} - * @memberof GetIndicesSnapshot200ResponseResultsInner - */ - 'last_updated'?: number; - /** - * The market status for the market that trades this ticker. - * @type {string} - * @memberof GetIndicesSnapshot200ResponseResultsInner - */ - 'market_status'?: string; - /** - * The error message while looking for this ticker. - * @type {string} - * @memberof GetIndicesSnapshot200ResponseResultsInner - */ - 'message'?: string; - /** - * Name of Index. - * @type {string} - * @memberof GetIndicesSnapshot200ResponseResultsInner - */ - 'name'?: string; - /** - * - * @type {GetIndicesSnapshot200ResponseResultsInnerSession} - * @memberof GetIndicesSnapshot200ResponseResultsInner - */ - 'session'?: GetIndicesSnapshot200ResponseResultsInnerSession; - /** - * Ticker of asset queried. - * @type {string} - * @memberof GetIndicesSnapshot200ResponseResultsInner + * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote */ - 'ticker': string; + 'a': number; /** - * The time relevance of the data. - * @type {string} - * @memberof GetIndicesSnapshot200ResponseResultsInner + * The bid price. + * @type {number} + * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote */ - 'timeframe'?: GetIndicesSnapshot200ResponseResultsInnerTimeframeEnum; + 'b': number; /** - * The indices market. - * @type {string} - * @memberof GetIndicesSnapshot200ResponseResultsInner + * The millisecond accuracy timestamp of the quote. + * @type {number} + * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote */ - 'type'?: GetIndicesSnapshot200ResponseResultsInnerTypeEnum; + 't': number; /** - * Value of Index. + * The exchange ID on which this quote happened. * @type {number} - * @memberof GetIndicesSnapshot200ResponseResultsInner + * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerLastQuote */ - 'value'?: number; -} - -/** - * @export - * @enum {string} - */ -export enum GetIndicesSnapshot200ResponseResultsInnerTimeframeEnum { - Delayed = 'DELAYED', - RealTime = 'REAL-TIME' -} -/** - * @export - * @enum {string} - */ -export enum GetIndicesSnapshot200ResponseResultsInnerTypeEnum { - Indices = 'indices' + 'x': number; } - /** - * Trading session metrics, detailing change percentages and key price points (open, close, high, low) for the asset within the current trading day. + * The most recent minute bar for this ticker. * @export - * @interface GetIndicesSnapshot200ResponseResultsInnerSession + * @interface GetForexSnapshotTickers200ResponseAllOfTickersInnerMin */ -export interface GetIndicesSnapshot200ResponseResultsInnerSession { +export interface GetForexSnapshotTickers200ResponseAllOfTickersInnerMin { /** - * The value of the change for the index from the previous trading day. + * The close price for the symbol in the given time period. * @type {number} - * @memberof GetIndicesSnapshot200ResponseResultsInnerSession + * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerMin */ - 'change'?: number; + 'c'?: number; /** - * The percent of the change for the index from the previous trading day. + * The highest price for the symbol in the given time period. * @type {number} - * @memberof GetIndicesSnapshot200ResponseResultsInnerSession + * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerMin */ - 'change_percent'?: number; + 'h'?: number; /** - * The closing value for the index of the day. + * The lowest price for the symbol in the given time period. * @type {number} - * @memberof GetIndicesSnapshot200ResponseResultsInnerSession + * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerMin */ - 'close'?: number; + 'l'?: number; /** - * The highest value for the index of the day. + * The number of transactions in the aggregate window. * @type {number} - * @memberof GetIndicesSnapshot200ResponseResultsInnerSession + * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerMin */ - 'high'?: number; + 'n'?: number; /** - * The lowest value for the index of the day. + * The open price for the symbol in the given time period. * @type {number} - * @memberof GetIndicesSnapshot200ResponseResultsInnerSession + * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerMin */ - 'low'?: number; + 'o'?: number; /** - * The open value for the index of the day. + * The Unix millisecond timestamp for the start of the aggregate window. * @type {number} - * @memberof GetIndicesSnapshot200ResponseResultsInnerSession + * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerMin */ - 'open'?: number; + 't'?: number; /** - * The closing value for the index of previous trading day. + * The trading volume of the symbol in the given time period. * @type {number} - * @memberof GetIndicesSnapshot200ResponseResultsInnerSession + * @memberof GetForexSnapshotTickers200ResponseAllOfTickersInnerMin */ - 'previous_close'?: number; + 'v'?: number; } /** * * @export - * @interface GetLastCryptoTrade200Response + * @interface GetForexV1Exchanges200Response */ -export interface GetLastCryptoTrade200Response { +export interface GetForexV1Exchanges200Response { /** - * - * @type {GetLastCryptoTrade200ResponseLast} - * @memberof GetLastCryptoTrade200Response + * If present, this value can be used to fetch the next page. + * @type {string} + * @memberof GetForexV1Exchanges200Response */ - 'last'?: GetLastCryptoTrade200ResponseLast; + 'next_url'?: string; /** * A request id assigned by the server. * @type {string} - * @memberof GetLastCryptoTrade200Response + * @memberof GetForexV1Exchanges200Response */ 'request_id': string; /** - * The status of this request\'s response. - * @type {string} - * @memberof GetLastCryptoTrade200Response + * The results for this request. + * @type {Array} + * @memberof GetForexV1Exchanges200Response */ - 'status': string; + 'results': Array; /** - * The symbol pair that was evaluated from the request. + * The status of this request\'s response. * @type {string} - * @memberof GetLastCryptoTrade200Response + * @memberof GetForexV1Exchanges200Response */ - 'symbol': string; + 'status': GetForexV1Exchanges200ResponseStatusEnum; } + /** - * Contains the requested trade data for the specified cryptocurrency pair. + * @export + * @enum {string} + */ +export enum GetForexV1Exchanges200ResponseStatusEnum { + Ok = 'OK' +} + +/** + * * @export - * @interface GetLastCryptoTrade200ResponseLast + * @interface GetForexV1Exchanges200ResponseResultsInner */ -export interface GetLastCryptoTrade200ResponseLast { - /** - * A list of condition codes. - * @type {Array} - * @memberof GetLastCryptoTrade200ResponseLast - */ - 'conditions'?: Array; - /** - * The exchange that this crypto trade happened on. See Exchanges for a mapping of exchanges to IDs. - * @type {number} - * @memberof GetLastCryptoTrade200ResponseLast - */ - 'exchange': number; +export interface GetForexV1Exchanges200ResponseResultsInner { /** - * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. - * @type {number} - * @memberof GetLastCryptoTrade200ResponseLast + * Numeric identifier for the forex trading venue or institution. + * @type {string} + * @memberof GetForexV1Exchanges200ResponseResultsInner */ - 'price': number; + 'id': string; /** - * The size of a trade (also known as volume). - * @type {number} - * @memberof GetLastCryptoTrade200ResponseLast + * Full name of the foreign exchange trading venue, platform, or financial institution. + * @type {string} + * @memberof GetForexV1Exchanges200ResponseResultsInner */ - 'size': number; + 'name': string; /** - * The Unix millisecond timestamp. - * @type {number} - * @memberof GetLastCryptoTrade200ResponseLast + * Type of forex venue - \'exchange\' for electronic trading platforms and institutional trading venues. + * @type {string} + * @memberof GetForexV1Exchanges200ResponseResultsInner */ - 'timestamp': number; + 'type': string; } /** * * @export - * @interface GetLastCurrencyQuote200Response + * @interface GetFuturesAggregates200Response */ -export interface GetLastCurrencyQuote200Response { +export interface GetFuturesAggregates200Response { + /** + * If present, the URL to the next page of results. + * @type {string} + * @memberof GetFuturesAggregates200Response + */ + 'next_url'?: string; /** * - * @type {GetCurrencyConversion200ResponseLast} - * @memberof GetLastCurrencyQuote200Response + * @type {Array} + * @memberof GetFuturesAggregates200Response */ - 'last'?: GetCurrencyConversion200ResponseLast; + 'results': Array; /** - * A request id assigned by the server. + * The status of the response. * @type {string} - * @memberof GetLastCurrencyQuote200Response - */ - 'request_id': string; - /** - * The status of this request\'s response. - * @type {string} - * @memberof GetLastCurrencyQuote200Response + * @memberof GetFuturesAggregates200Response */ 'status': string; - /** - * The symbol pair that was evaluated from the request. - * @type {string} - * @memberof GetLastCurrencyQuote200Response - */ - 'symbol': string; } /** * * @export - * @interface GetLastOptionsTrade200Response + * @interface GetFuturesAggregates200ResponseResultsInner */ -export interface GetLastOptionsTrade200Response { - /** - * A request id assigned by the server. - * @type {string} - * @memberof GetLastOptionsTrade200Response - */ - 'request_id': string; - /** - * - * @type {GetLastOptionsTrade200ResponseResults} - * @memberof GetLastOptionsTrade200Response - */ - 'results'?: GetLastOptionsTrade200ResponseResults; +export interface GetFuturesAggregates200ResponseResultsInner { /** - * The status of this request\'s response. - * @type {string} - * @memberof GetLastOptionsTrade200Response + * The last price within the timeframe. + * @type {number} + * @memberof GetFuturesAggregates200ResponseResultsInner */ - 'status': string; -} -/** - * - * @export - * @interface GetLastOptionsTrade200ResponseResults - */ -export interface GetLastOptionsTrade200ResponseResults { + 'close': number; /** - * The exchange symbol that this item is traded under. - * @type {string} - * @memberof GetLastOptionsTrade200ResponseResults + * The total dollar volume of the transactions that occurred within the timeframe. + * @type {number} + * @memberof GetFuturesAggregates200ResponseResultsInner */ - 'T': string; + 'dollar_volume': number; /** - * A list of condition codes. - * @type {Array} - * @memberof GetLastOptionsTrade200ResponseResults + * The highest price within the timeframe. + * @type {number} + * @memberof GetFuturesAggregates200ResponseResultsInner */ - 'c'?: Array; + 'high': number; /** - * The trade correction indicator. + * The lowest price within the timeframe. * @type {number} - * @memberof GetLastOptionsTrade200ResponseResults + * @memberof GetFuturesAggregates200ResponseResultsInner */ - 'e'?: number; + 'low': number; /** - * The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message. + * The opening price within the timeframe. * @type {number} - * @memberof GetLastOptionsTrade200ResponseResults + * @memberof GetFuturesAggregates200ResponseResultsInner */ - 'f'?: number; + 'open': number; /** - * The Trade ID which uniquely identifies a trade. These are unique per combination of ticker, exchange, and TRF. For example: A trade for AAPL executed on NYSE and a trade for AAPL executed on NASDAQ could potentially have the same Trade ID. + * Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format. * @type {string} - * @memberof GetLastOptionsTrade200ResponseResults + * @memberof GetFuturesAggregates200ResponseResultsInner */ - 'i': string; + 'session_end_date': string; /** - * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. + * The price the contract would have cost to settle for this session. * @type {number} - * @memberof GetLastOptionsTrade200ResponseResults + * @memberof GetFuturesAggregates200ResponseResultsInner */ - 'p': number; + 'settlement_price'?: number; /** - * The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). - * @type {number} - * @memberof GetLastOptionsTrade200ResponseResults + * The ticker for the contract. + * @type {string} + * @memberof GetFuturesAggregates200ResponseResultsInner */ - 'q': number; + 'ticker': string; /** - * The ID for the Trade Reporting Facility where the trade took place. + * The number of transactions that occurred within the timeframe. * @type {number} - * @memberof GetLastOptionsTrade200ResponseResults + * @memberof GetFuturesAggregates200ResponseResultsInner */ - 'r'?: number; + 'transactions': number; /** - * The size of a trade (also known as volume). + * The number of contracts that traded within the timeframe. * @type {number} - * @memberof GetLastOptionsTrade200ResponseResults + * @memberof GetFuturesAggregates200ResponseResultsInner */ - 's'?: number; + 'volume': number; /** - * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. + * The timestamp of the beginning of the candlestick’s aggregation window. * @type {number} - * @memberof GetLastOptionsTrade200ResponseResults + * @memberof GetFuturesAggregates200ResponseResultsInner */ - 't': number; + 'window_start': number; +} +/** + * + * @export + * @interface GetFuturesContractDetails200Response + */ +export interface GetFuturesContractDetails200Response { /** - * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. - * @type {number} - * @memberof GetLastOptionsTrade200ResponseResults + * A unique identifier for this request. + * @type {string} + * @memberof GetFuturesContractDetails200Response */ - 'x': number; + 'request_id': string; /** - * The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange. - * @type {number} - * @memberof GetLastOptionsTrade200ResponseResults + * + * @type {GetFuturesContracts200ResponseResultsInner} + * @memberof GetFuturesContractDetails200Response */ - 'y': number; + 'results'?: GetFuturesContracts200ResponseResultsInner; /** - * There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C. * Tape A is NYSE listed securities * Tape B is NYSE ARCA / NYSE American * Tape C is NASDAQ - * @type {number} - * @memberof GetLastOptionsTrade200ResponseResults + * The status of this request\'s response. + * @type {string} + * @memberof GetFuturesContractDetails200Response */ - 'z'?: number; + 'status': string; } /** * * @export - * @interface GetLastStocksQuote200Response + * @interface GetFuturesContracts200Response */ -export interface GetLastStocksQuote200Response { +export interface GetFuturesContracts200Response { /** - * A request id assigned by the server. + * If present, this value can be used to fetch the next page of data. * @type {string} - * @memberof GetLastStocksQuote200Response + * @memberof GetFuturesContracts200Response + */ + 'next_url'?: string; + /** + * A unique identifier for this request. + * @type {string} + * @memberof GetFuturesContracts200Response */ 'request_id': string; /** * - * @type {GetLastStocksQuote200ResponseResults} - * @memberof GetLastStocksQuote200Response + * @type {Array} + * @memberof GetFuturesContracts200Response */ - 'results'?: GetLastStocksQuote200ResponseResults; + 'results'?: Array; /** * The status of this request\'s response. * @type {string} - * @memberof GetLastStocksQuote200Response + * @memberof GetFuturesContracts200Response */ 'status': string; } /** * * @export - * @interface GetLastStocksQuote200ResponseResults + * @interface GetFuturesContracts200ResponseResultsInner */ -export interface GetLastStocksQuote200ResponseResults { - /** - * The ask price. - * @type {number} - * @memberof GetLastStocksQuote200ResponseResults - */ - 'P'?: number; +export interface GetFuturesContracts200ResponseResultsInner { /** - * The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price. - * @type {number} - * @memberof GetLastStocksQuote200ResponseResults + * Whether or not this contract was tradeable at the given point-in-time specified in the \'as_of\' attribute (a contract was active if the given day was after the \'first_trade_date\' and before the \'last_trade_date\'). + * @type {boolean} + * @memberof GetFuturesContracts200ResponseResultsInner */ - 'S'?: number; + 'active': boolean; /** - * The exchange symbol that this item is traded under. + * The point-in-time date for the given contract - e.g. if \'as_of\' is set to 2021-04-25, then the data retrieved describes the contract(s) as of 2021-04-25. * @type {string} - * @memberof GetLastStocksQuote200ResponseResults + * @memberof GetFuturesContracts200ResponseResultsInner */ - 'T': string; + 'as_of'?: string; /** - * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. + * The number of days until this contract matures (since the point-in-time date). Note that the absence of this field means there are 0 days until maturity. * @type {number} - * @memberof GetLastStocksQuote200ResponseResults + * @memberof GetFuturesContracts200ResponseResultsInner */ - 'X'?: number; + 'days_to_maturity'?: number; /** - * A list of condition codes. - * @type {Array} - * @memberof GetLastStocksQuote200ResponseResults + * The date on which this contract first became tradeable. + * @type {string} + * @memberof GetFuturesContracts200ResponseResultsInner */ - 'c'?: Array; + 'first_trade_date': string; /** - * The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message. - * @type {number} - * @memberof GetLastStocksQuote200ResponseResults + * The date on which this contract last became tradeable. + * @type {string} + * @memberof GetFuturesContracts200ResponseResultsInner */ - 'f'?: number; + 'last_trade_date': string; /** - * A list of indicator codes. - * @type {Array} - * @memberof GetLastStocksQuote200ResponseResults + * This field provides the calendar month reflected in the instrument symbol. For futures spreads and options spreads, this field contains the first leg\'s calendar month reflected in the instrument symbol. For daily products, this tag contains the full calendar date (YYYYMMDD) as reflected in the instrument symbol. + * @type {string} + * @memberof GetFuturesContracts200ResponseResultsInner */ - 'i'?: Array; + 'maturity'?: string; /** - * The bid price. + * The maximum order quantity for this contract. * @type {number} - * @memberof GetLastStocksQuote200ResponseResults + * @memberof GetFuturesContracts200ResponseResultsInner */ - 'p'?: number; + 'max_order_quantity'?: number; /** - * The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). + * The minimum order quantity for this contract. * @type {number} - * @memberof GetLastStocksQuote200ResponseResults + * @memberof GetFuturesContracts200ResponseResultsInner */ - 'q': number; + 'min_order_quantity'?: number; /** - * The bid size. This represents the number of round lot orders at the given bid price. The normal round lot size is 100 shares. A bid size of 2 means there are 200 shares for purchase at the given bid price. - * @type {number} - * @memberof GetLastStocksQuote200ResponseResults + * The name of the contract. + * @type {string} + * @memberof GetFuturesContracts200ResponseResultsInner */ - 's'?: number; + 'name'?: string; /** - * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. - * @type {number} - * @memberof GetLastStocksQuote200ResponseResults + * The unique identifier for the product to which this contract belongs. + * @type {string} + * @memberof GetFuturesContracts200ResponseResultsInner */ - 't': number; + 'product_code': string; /** - * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. - * @type {number} - * @memberof GetLastStocksQuote200ResponseResults + * The final settlement date for the contract. + * @type {string} + * @memberof GetFuturesContracts200ResponseResultsInner */ - 'x'?: number; + 'settlement_date'?: string; /** - * The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange. + * The settlement tick size for this contract. * @type {number} - * @memberof GetLastStocksQuote200ResponseResults + * @memberof GetFuturesContracts200ResponseResultsInner */ - 'y': number; + 'settlement_tick_size'?: number; /** - * There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C. * Tape A is NYSE listed securities * Tape B is NYSE ARCA / NYSE American * Tape C is NASDAQ + * The spread tick size for this contract. * @type {number} - * @memberof GetLastStocksQuote200ResponseResults + * @memberof GetFuturesContracts200ResponseResultsInner */ - 'z'?: number; -} -/** - * - * @export - * @interface GetMarketHolidays200ResponseInner - */ -export interface GetMarketHolidays200ResponseInner { + 'spread_tick_size'?: number; /** - * The market close time on the holiday (if it\'s not closed). + * The unique identifier for the contract, typically consisting of the product code and expiration date. * @type {string} - * @memberof GetMarketHolidays200ResponseInner + * @memberof GetFuturesContracts200ResponseResultsInner */ - 'close'?: string; + 'ticker': string; /** - * The date of the holiday. + * The tick size for this contract. + * @type {number} + * @memberof GetFuturesContracts200ResponseResultsInner + */ + 'trade_tick_size'?: number; + /** + * The trading venue (MIC) for the exchange on which this contract trades. * @type {string} - * @memberof GetMarketHolidays200ResponseInner + * @memberof GetFuturesContracts200ResponseResultsInner */ - 'date'?: string; + 'trading_venue': string; /** - * Which market the record is for. + * The type of contract, one of \"single\" or \"combo\". * @type {string} - * @memberof GetMarketHolidays200ResponseInner + * @memberof GetFuturesContracts200ResponseResultsInner */ - 'exchange'?: string; + 'type': string; +} +/** + * + * @export + * @interface GetFuturesDailySchedules200Response + */ +export interface GetFuturesDailySchedules200Response { /** - * The name of the holiday. + * The URL for the next page of results. * @type {string} - * @memberof GetMarketHolidays200ResponseInner + * @memberof GetFuturesDailySchedules200Response */ - 'name'?: string; + 'next_url'?: string; /** - * The market open time on the holiday (if it\'s not closed). + * The unique identifier for this request. * @type {string} - * @memberof GetMarketHolidays200ResponseInner + * @memberof GetFuturesDailySchedules200Response */ - 'open'?: string; + 'request_id': string; /** - * The status of the market on the holiday. + * A list of schedules for each product. + * @type {Array} + * @memberof GetFuturesDailySchedules200Response + */ + 'results'?: Array; + /** + * The status of the response. * @type {string} - * @memberof GetMarketHolidays200ResponseInner + * @memberof GetFuturesDailySchedules200Response */ - 'status'?: string; + 'status': string; } /** * * @export - * @interface GetMarketStatus200Response + * @interface GetFuturesMarketStatuses200Response */ -export interface GetMarketStatus200Response { - /** - * Whether or not the market is in post-market hours. - * @type {boolean} - * @memberof GetMarketStatus200Response - */ - 'afterHours'?: boolean; - /** - * - * @type {GetMarketStatus200ResponseCurrencies} - * @memberof GetMarketStatus200Response - */ - 'currencies'?: GetMarketStatus200ResponseCurrencies; +export interface GetFuturesMarketStatuses200Response { /** - * Whether or not the market is in pre-market hours. - * @type {boolean} - * @memberof GetMarketStatus200Response + * If present, this value can be used to fetch the next page of data. + * @type {string} + * @memberof GetFuturesMarketStatuses200Response */ - 'earlyHours'?: boolean; + 'next_url'?: string; /** - * - * @type {GetMarketStatus200ResponseExchanges} - * @memberof GetMarketStatus200Response + * A unique identifier for this request. + * @type {string} + * @memberof GetFuturesMarketStatuses200Response */ - 'exchanges'?: GetMarketStatus200ResponseExchanges; + 'request_id': string; /** * - * @type {GetMarketStatus200ResponseIndicesGroups} - * @memberof GetMarketStatus200Response + * @type {Array} + * @memberof GetFuturesMarketStatuses200Response */ - 'indicesGroups'?: GetMarketStatus200ResponseIndicesGroups; + 'results'?: Array; /** - * The status of the market as a whole. + * The status of this request\'s response. * @type {string} - * @memberof GetMarketStatus200Response + * @memberof GetFuturesMarketStatuses200Response */ - 'market'?: string; + 'status': string; /** - * The current time of the server, returned as a date-time in RFC3339 format. + * An RFC3339 timestamp representing the moment at which the market statuses were evaluated. * @type {string} - * @memberof GetMarketStatus200Response + * @memberof GetFuturesMarketStatuses200Response */ - 'serverTime'?: string; + 'timestamp': string; } /** - * Contains the status of various currency markets. + * * @export - * @interface GetMarketStatus200ResponseCurrencies + * @interface GetFuturesMarketStatuses200ResponseResultsInner */ -export interface GetMarketStatus200ResponseCurrencies { +export interface GetFuturesMarketStatuses200ResponseResultsInner { /** - * The status of the crypto market. + * The current status of the market. * @type {string} - * @memberof GetMarketStatus200ResponseCurrencies + * @memberof GetFuturesMarketStatuses200ResponseResultsInner */ - 'crypto'?: string; + 'market_status': GetFuturesMarketStatuses200ResponseResultsInnerMarketStatusEnum; /** - * The status of the forex market. + * The product code for the product. * @type {string} - * @memberof GetMarketStatus200ResponseCurrencies + * @memberof GetFuturesMarketStatuses200ResponseResultsInner */ - 'fx'?: string; + 'product_code': string; + /** + * The trading venue (MIC) for the exchange on which the corresponding product trades. + * @type {string} + * @memberof GetFuturesMarketStatuses200ResponseResultsInner + */ + 'trading_venue'?: string; } + /** - * Contains the status of different US stock exchanges (e.g., Nasdaq, NYSE). + * @export + * @enum {string} + */ +export enum GetFuturesMarketStatuses200ResponseResultsInnerMarketStatusEnum { + PreOpen = 'pre_open', + Open = 'open', + Close = 'close', + Pause = 'pause', + PostClosePreOpen = 'post_close_pre_open' +} + +/** + * * @export - * @interface GetMarketStatus200ResponseExchanges + * @interface GetFuturesProductDetails200Response */ -export interface GetMarketStatus200ResponseExchanges { +export interface GetFuturesProductDetails200Response { /** - * The status of the Nasdaq market. + * A unique identifier for this request. * @type {string} - * @memberof GetMarketStatus200ResponseExchanges + * @memberof GetFuturesProductDetails200Response */ - 'nasdaq'?: string; + 'request_id': string; /** - * The status of the NYSE market. - * @type {string} - * @memberof GetMarketStatus200ResponseExchanges + * + * @type {GetFuturesProducts200ResponseResultsInner} + * @memberof GetFuturesProductDetails200Response */ - 'nyse'?: string; + 'results'?: GetFuturesProducts200ResponseResultsInner; /** - * The status of the OTC market. + * The status of this request\'s response. * @type {string} - * @memberof GetMarketStatus200ResponseExchanges + * @memberof GetFuturesProductDetails200Response */ - 'otc'?: string; + 'status': string; } /** - * Contains the status of various index groups (e.g., MSCI, FTSE Russell). + * * @export - * @interface GetMarketStatus200ResponseIndicesGroups + * @interface GetFuturesProductSchedules200Response */ -export interface GetMarketStatus200ResponseIndicesGroups { +export interface GetFuturesProductSchedules200Response { /** - * The status of Cboe Streaming Market Indices Cryptocurrency (\"CCCY\") indices trading hours. + * An optional error message for failed requests when available. * @type {string} - * @memberof GetMarketStatus200ResponseIndicesGroups + * @memberof GetFuturesProductSchedules200Response */ - 'cccy'?: string; + 'error'?: string; /** - * The status of Cboe Global Indices (\"CGI\") trading hours. + * If present, this value can be used to fetch the next page of data. * @type {string} - * @memberof GetMarketStatus200ResponseIndicesGroups + * @memberof GetFuturesProductSchedules200Response */ - 'cgi'?: string; + 'next_url'?: string; /** - * The status of Dow Jones indices trading hours + * The unique identifier for the request. * @type {string} - * @memberof GetMarketStatus200ResponseIndicesGroups + * @memberof GetFuturesProductSchedules200Response */ - 'dow_jones'?: string; + 'request_id': string; /** - * The status of Financial Times Stock Exchange Group (\"FTSE\") Russell indices trading hours. - * @type {string} - * @memberof GetMarketStatus200ResponseIndicesGroups + * The list of schedules for the specified product. + * @type {Array} + * @memberof GetFuturesProductSchedules200Response */ - 'ftse_russell'?: string; + 'results'?: Array; /** - * The status of Morgan Stanley Capital International (\"MSCI\") indices trading hours. + * The status of the response. * @type {string} - * @memberof GetMarketStatus200ResponseIndicesGroups + * @memberof GetFuturesProductSchedules200Response */ - 'msci'?: string; + 'status': string; +} +/** + * + * @export + * @interface GetFuturesProductSchedules200ResponseResultsInner + */ +export interface GetFuturesProductSchedules200ResponseResultsInner { /** - * The status of Morningstar (\"MSTAR\") indices trading hours. + * The product code for the futures product to which this schedule applies. * @type {string} - * @memberof GetMarketStatus200ResponseIndicesGroups + * @memberof GetFuturesProductSchedules200ResponseResultsInner */ - 'mstar'?: string; + 'product_code': string; /** - * The status of Morningstar Customer (\"MSTARC\") indices trading hours. + * The name of the futures product to which this schedule applies. * @type {string} - * @memberof GetMarketStatus200ResponseIndicesGroups + * @memberof GetFuturesProductSchedules200ResponseResultsInner */ - 'mstarc'?: string; + 'product_name'?: string; /** - * The status of National Association of Securities Dealers Automated Quotations (\"Nasdaq\") indices trading hours. - * @type {string} - * @memberof GetMarketStatus200ResponseIndicesGroups + * + * @type {Array} + * @memberof GetFuturesProductSchedules200ResponseResultsInner */ - 'nasdaq'?: string; + 'schedule': Array; /** - * The status of Standard & Poors\'s (\"S&P\") indices trading hours. + * The date on which the schedule\'s trading day ended (sometimes referred to as trading date) formatted as `YYYY-MM-DD`. Note that although there is no time component on this attribute, the day refers to Central Time. * @type {string} - * @memberof GetMarketStatus200ResponseIndicesGroups + * @memberof GetFuturesProductSchedules200ResponseResultsInner */ - 's_and_p'?: string; + 'session_end_date': string; /** - * The status of Societe Generale indices trading hours. + * The trading venue (MIC) for the exchange on which this schedule\'s product trades. * @type {string} - * @memberof GetMarketStatus200ResponseIndicesGroups + * @memberof GetFuturesProductSchedules200ResponseResultsInner */ - 'societe_generale'?: string; + 'trading_venue'?: string; } /** * * @export - * @interface GetOptionContract200Response + * @interface GetFuturesProductSchedules200ResponseResultsInnerScheduleInner */ -export interface GetOptionContract200Response { +export interface GetFuturesProductSchedules200ResponseResultsInnerScheduleInner { /** - * If present, this value can be used to fetch the next page of data. + * The market event for this schedule. * @type {string} - * @memberof GetOptionContract200Response - */ - 'next_url'?: string; - /** - * A request id assigned by the server. - * @type {string} - * @memberof GetOptionContract200Response - */ - 'request_id': string; - /** - * - * @type {GetOptionsChain200ResponseResultsInner} - * @memberof GetOptionContract200Response + * @memberof GetFuturesProductSchedules200ResponseResultsInnerScheduleInner */ - 'results'?: GetOptionsChain200ResponseResultsInner; + 'event': GetFuturesProductSchedules200ResponseResultsInnerScheduleInnerEventEnum; /** - * The status of this request\'s response. + * The timestamp for this market event in Central Time. * @type {string} - * @memberof GetOptionContract200Response + * @memberof GetFuturesProductSchedules200ResponseResultsInnerScheduleInner */ - 'status': string; + 'timestamp': string; +} + +/** + * @export + * @enum {string} + */ +export enum GetFuturesProductSchedules200ResponseResultsInnerScheduleInnerEventEnum { + PreOpen = 'pre_open', + Open = 'open', + Close = 'close', + Pause = 'pause', + PostClosePreOpen = 'post_close_pre_open' } + /** * * @export - * @interface GetOptionsChain200Response + * @interface GetFuturesProducts200Response */ -export interface GetOptionsChain200Response { +export interface GetFuturesProducts200Response { /** * If present, this value can be used to fetch the next page of data. * @type {string} - * @memberof GetOptionsChain200Response + * @memberof GetFuturesProducts200Response */ 'next_url'?: string; /** - * A request id assigned by the server. + * A unique identifier for this request. * @type {string} - * @memberof GetOptionsChain200Response + * @memberof GetFuturesProducts200Response */ 'request_id': string; /** - * An array of results containing the requested data. - * @type {Array} - * @memberof GetOptionsChain200Response + * + * @type {Array} + * @memberof GetFuturesProducts200Response */ - 'results'?: Array; + 'results'?: Array; /** * The status of this request\'s response. * @type {string} - * @memberof GetOptionsChain200Response + * @memberof GetFuturesProducts200Response */ 'status': string; } /** - * Contains the requested snapshot data for the specified contract. + * * @export - * @interface GetOptionsChain200ResponseResultsInner + * @interface GetFuturesProducts200ResponseResultsInner */ -export interface GetOptionsChain200ResponseResultsInner { - /** - * The price of the underlying asset for the contract to break even. For a call, this value is (strike price + premium paid). For a put, this value is (strike price - premium paid). - * @type {number} - * @memberof GetOptionsChain200ResponseResultsInner - */ - 'break_even_price': number; - /** - * - * @type {GetOptionsChain200ResponseResultsInnerDay} - * @memberof GetOptionsChain200ResponseResultsInner - */ - 'day': GetOptionsChain200ResponseResultsInnerDay; +export interface GetFuturesProducts200ResponseResultsInner { /** - * - * @type {GetOptionsChain200ResponseResultsInnerDetails} - * @memberof GetOptionsChain200ResponseResultsInner + * The point-in-time date for the given product - e.g. if \'as_of\' is set to 2024-11-05, then these were the details for this product on that day. + * @type {string} + * @memberof GetFuturesProducts200ResponseResultsInner */ - 'details': GetOptionsChain200ResponseResultsInnerDetails; + 'as_of'?: string; /** - * Fair market value is only available on Business plans. It\'s it our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us. - * @type {number} - * @memberof GetOptionsChain200ResponseResultsInner + * The asset class to which the product belongs. + * @type {string} + * @memberof GetFuturesProducts200ResponseResultsInner */ - 'fmv'?: number; + 'asset_class'?: string; /** - * - * @type {GetSnapshots200ResponseResultsInnerGreeks} - * @memberof GetOptionsChain200ResponseResultsInner + * The asset sub-class to which the product belongs. + * @type {string} + * @memberof GetFuturesProducts200ResponseResultsInner */ - 'greeks'?: GetSnapshots200ResponseResultsInnerGreeks; + 'asset_sub_class'?: string; /** - * The market\'s forecast for the volatility of the underlying asset, based on this option\'s current price. - * @type {number} - * @memberof GetOptionsChain200ResponseResultsInner + * The clearing channel for this product. Indicates whether the product can be cleared only through exchanges or through both exchanges and over-the-counter. + * @type {string} + * @memberof GetFuturesProducts200ResponseResultsInner */ - 'implied_volatility'?: number; + 'clearing_channel'?: GetFuturesProducts200ResponseResultsInnerClearingChannelEnum; /** - * - * @type {GetOptionsChain200ResponseResultsInnerLastQuote} - * @memberof GetOptionsChain200ResponseResultsInner + * The date and time at which this product was last updated. + * @type {string} + * @memberof GetFuturesProducts200ResponseResultsInner */ - 'last_quote': GetOptionsChain200ResponseResultsInnerLastQuote; + 'last_updated'?: string; /** - * - * @type {GetOptionsChain200ResponseResultsInnerLastTrade} - * @memberof GetOptionsChain200ResponseResultsInner + * The full name of the product. + * @type {string} + * @memberof GetFuturesProducts200ResponseResultsInner */ - 'last_trade'?: GetOptionsChain200ResponseResultsInnerLastTrade; + 'name'?: string; /** - * The quantity of this contract held at the end of the last trading day. - * @type {number} - * @memberof GetOptionsChain200ResponseResultsInner + * The quoted price for this product. + * @type {string} + * @memberof GetFuturesProducts200ResponseResultsInner */ - 'open_interest': number; + 'price_quotation'?: string; /** - * - * @type {GetSnapshots200ResponseResultsInnerUnderlyingAsset} - * @memberof GetOptionsChain200ResponseResultsInner + * The unique identifier for the product. + * @type {string} + * @memberof GetFuturesProducts200ResponseResultsInner */ - 'underlying_asset': GetSnapshots200ResponseResultsInnerUnderlyingAsset; -} -/** - * The most recent daily bar for this contract. - * @export - * @interface GetOptionsChain200ResponseResultsInnerDay - */ -export interface GetOptionsChain200ResponseResultsInnerDay { + 'product_code': string; /** - * The value of the price change for the contract from the previous trading day. - * @type {number} - * @memberof GetOptionsChain200ResponseResultsInnerDay + * The sector to which the product belongs. + * @type {string} + * @memberof GetFuturesProducts200ResponseResultsInner */ - 'change': number; + 'sector'?: string; /** - * The percent of the price change for the contract from the previous trading day. - * @type {number} - * @memberof GetOptionsChain200ResponseResultsInnerDay + * The currency in which this product settles. + * @type {string} + * @memberof GetFuturesProducts200ResponseResultsInner */ - 'change_percent': number; + 'settlement_currency_code'?: string; /** - * The closing price for the contract of the day. - * @type {number} - * @memberof GetOptionsChain200ResponseResultsInnerDay + * The method of settlement for this product (Financially Settled or Deliverable). + * @type {string} + * @memberof GetFuturesProducts200ResponseResultsInner */ - 'close': number; + 'settlement_method'?: string; /** - * The highest price for the contract of the day. - * @type {number} - * @memberof GetOptionsChain200ResponseResultsInnerDay + * The type of settlement for this product. + * @type {string} + * @memberof GetFuturesProducts200ResponseResultsInner */ - 'high': number; + 'settlement_type'?: string; /** - * The nanosecond timestamp of when this information was updated. - * @type {number} - * @memberof GetOptionsChain200ResponseResultsInnerDay + * The sub-sector to which the product belongs. + * @type {string} + * @memberof GetFuturesProducts200ResponseResultsInner */ - 'last_updated'?: number; + 'sub_sector'?: string; /** - * The lowest price for the contract of the day. - * @type {number} - * @memberof GetOptionsChain200ResponseResultsInnerDay + * The currency in which this product trades. + * @type {string} + * @memberof GetFuturesProducts200ResponseResultsInner */ - 'low': number; + 'trade_currency_code'?: string; /** - * The open price for the contract of the day. - * @type {number} - * @memberof GetOptionsChain200ResponseResultsInnerDay + * The trading venue (MIC) for the exchange on which this contract trades. + * @type {string} + * @memberof GetFuturesProducts200ResponseResultsInner */ - 'open': number; + 'trading_venue'?: string; /** - * The closing price for the contract of previous trading day. - * @type {number} - * @memberof GetOptionsChain200ResponseResultsInnerDay + * The type of product, one of \"single\" or \"combo\". + * @type {string} + * @memberof GetFuturesProducts200ResponseResultsInner */ - 'previous_close': number; + 'type'?: string; /** - * The trading volume for the contract of the day. - * @type {number} - * @memberof GetOptionsChain200ResponseResultsInnerDay + * The unit of measure for this product. + * @type {string} + * @memberof GetFuturesProducts200ResponseResultsInner */ - 'volume': number; + 'unit_of_measure'?: string; /** - * The trading volume weighted average price for the contract of the day. + * The quantity of the unit of measure for this product. * @type {number} - * @memberof GetOptionsChain200ResponseResultsInnerDay + * @memberof GetFuturesProducts200ResponseResultsInner */ - 'vwap': number; + 'unit_of_measure_quantity'?: number; } + /** - * The details for this contract. + * @export + * @enum {string} + */ +export enum GetFuturesProducts200ResponseResultsInnerClearingChannelEnum { + ExchangeOnly = 'exchange_only', + ExchangeAndOtc = 'exchange_and_otc' +} + +/** + * * @export - * @interface GetOptionsChain200ResponseResultsInnerDetails + * @interface GetFuturesQuotes200Response */ -export interface GetOptionsChain200ResponseResultsInnerDetails { +export interface GetFuturesQuotes200Response { /** - * The type of contract. Can be \"put\", \"call\", or in some rare cases, \"other\". + * If present, this value can be used to fetch the next page of data. * @type {string} - * @memberof GetOptionsChain200ResponseResultsInnerDetails + * @memberof GetFuturesQuotes200Response */ - 'contract_type': GetOptionsChain200ResponseResultsInnerDetailsContractTypeEnum; + 'next_url'?: string; /** - * The exercise style of this contract. See this link for more details on exercise styles. - * @type {string} - * @memberof GetOptionsChain200ResponseResultsInnerDetails + * + * @type {Array} + * @memberof GetFuturesQuotes200Response */ - 'exercise_style': GetOptionsChain200ResponseResultsInnerDetailsExerciseStyleEnum; + 'results'?: Array; /** - * The contract\'s expiration date in YYYY-MM-DD format. + * The status of this request\'s response. * @type {string} - * @memberof GetOptionsChain200ResponseResultsInnerDetails + * @memberof GetFuturesQuotes200Response */ - 'expiration_date': string; - /** - * The number of shares per contract for this contract. - * @type {number} - * @memberof GetOptionsChain200ResponseResultsInnerDetails - */ - 'shares_per_contract': number; - /** - * The strike price of the option contract. - * @type {number} - * @memberof GetOptionsChain200ResponseResultsInnerDetails - */ - 'strike_price': number; - /** - * The ticker symbol for the asset. - * @type {string} - * @memberof GetOptionsChain200ResponseResultsInnerDetails - */ - 'ticker': string; -} - -/** - * @export - * @enum {string} - */ -export enum GetOptionsChain200ResponseResultsInnerDetailsContractTypeEnum { - Put = 'put', - Call = 'call', - Other = 'other' -} -/** - * @export - * @enum {string} - */ -export enum GetOptionsChain200ResponseResultsInnerDetailsExerciseStyleEnum { - American = 'american', - European = 'european', - Bermudan = 'bermudan' + 'status': string; } - /** - * The most recent quote for this contract. This is only returned if your current plan includes quotes. + * * @export - * @interface GetOptionsChain200ResponseResultsInnerLastQuote + * @interface GetFuturesQuotes200ResponseResultsInner */ -export interface GetOptionsChain200ResponseResultsInnerLastQuote { +export interface GetFuturesQuotes200ResponseResultsInner { /** - * The ask price. + * The ask price is expressed per unit of the underlying asset, and you apply the contract multiplier to get the full contract value. * @type {number} - * @memberof GetOptionsChain200ResponseResultsInnerLastQuote + * @memberof GetFuturesQuotes200ResponseResultsInner */ - 'ask': number; + 'ask_price'?: number; /** - * The ask side exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. + * The quote size represents the number of futures contracts available at the given ask price. * @type {number} - * @memberof GetOptionsChain200ResponseResultsInnerLastQuote + * @memberof GetFuturesQuotes200ResponseResultsInner */ - 'ask_exchange'?: number; + 'ask_size'?: number; /** - * The ask size. + * The time when the ask price was submitted to the exchange. * @type {number} - * @memberof GetOptionsChain200ResponseResultsInnerLastQuote + * @memberof GetFuturesQuotes200ResponseResultsInner */ - 'ask_size': number; + 'ask_timestamp'?: number; /** - * The bid price. + * The bid price is expressed per unit of the underlying asset, and you apply the contract multiplier to get the full contract value. * @type {number} - * @memberof GetOptionsChain200ResponseResultsInnerLastQuote + * @memberof GetFuturesQuotes200ResponseResultsInner */ - 'bid': number; + 'bid_price'?: number; /** - * The bid side exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. + * The quote size represents the number of futures contracts available at the given bid price. * @type {number} - * @memberof GetOptionsChain200ResponseResultsInnerLastQuote + * @memberof GetFuturesQuotes200ResponseResultsInner */ - 'bid_exchange'?: number; + 'bid_size'?: number; /** - * The bid size. + * The time when the bid price was submitted to the exchange. * @type {number} - * @memberof GetOptionsChain200ResponseResultsInnerLastQuote + * @memberof GetFuturesQuotes200ResponseResultsInner */ - 'bid_size': number; + 'bid_timestamp'?: number; /** - * The nanosecond timestamp of when this information was updated. - * @type {number} - * @memberof GetOptionsChain200ResponseResultsInnerLastQuote + * Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format. + * @type {string} + * @memberof GetFuturesQuotes200ResponseResultsInner */ - 'last_updated'?: number; + 'session_end_date': string; /** - * The average of the bid and ask price. - * @type {number} - * @memberof GetOptionsChain200ResponseResultsInnerLastQuote + * The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract). + * @type {string} + * @memberof GetFuturesQuotes200ResponseResultsInner */ - 'midpoint': number; + 'ticker': string; /** - * The time relevance of the data. - * @type {string} - * @memberof GetOptionsChain200ResponseResultsInnerLastQuote + * The time when the quote was generated at the exchange to nanosecond precision. + * @type {number} + * @memberof GetFuturesQuotes200ResponseResultsInner */ - 'timeframe'?: GetOptionsChain200ResponseResultsInnerLastQuoteTimeframeEnum; -} - -/** - * @export - * @enum {string} - */ -export enum GetOptionsChain200ResponseResultsInnerLastQuoteTimeframeEnum { - Delayed = 'DELAYED', - RealTime = 'REAL-TIME' + 'timestamp': number; } - /** - * The most recent trade for this contract. This is only returned if your current plan includes trades. + * * @export - * @interface GetOptionsChain200ResponseResultsInnerLastTrade + * @interface GetFuturesTrades200Response */ -export interface GetOptionsChain200ResponseResultsInnerLastTrade { +export interface GetFuturesTrades200Response { /** - * A list of condition codes. - * @type {Array} - * @memberof GetOptionsChain200ResponseResultsInnerLastTrade + * If present, this value can be used to fetch the next page of data. + * @type {string} + * @memberof GetFuturesTrades200Response */ - 'conditions'?: Array; + 'next_url'?: string; /** - * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. - * @type {number} - * @memberof GetOptionsChain200ResponseResultsInnerLastTrade + * + * @type {Array} + * @memberof GetFuturesTrades200Response */ - 'exchange': number; + 'results'?: Array; /** - * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. + * The status of this request\'s response. + * @type {string} + * @memberof GetFuturesTrades200Response + */ + 'status': string; +} +/** + * + * @export + * @interface GetFuturesTrades200ResponseResultsInner + */ +export interface GetFuturesTrades200ResponseResultsInner { + /** + * The price of the trade. This is the actual dollar value per whole contract of this trade. A trade of 100 contracts with a price of $2.00 would be worth a total dollar value of $200.00. * @type {number} - * @memberof GetOptionsChain200ResponseResultsInnerLastTrade + * @memberof GetFuturesTrades200ResponseResultsInner */ 'price': number; /** - * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this trade from the exchange which produced it. - * @type {number} - * @memberof GetOptionsChain200ResponseResultsInnerLastTrade + * Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format. + * @type {string} + * @memberof GetFuturesTrades200ResponseResultsInner */ - 'sip_timestamp': number; + 'session_end_date': string; /** - * The size of a trade (also known as volume). + * The total number of contracts exchanged between buyers and sellers on a given trade. * @type {number} - * @memberof GetOptionsChain200ResponseResultsInnerLastTrade + * @memberof GetFuturesTrades200ResponseResultsInner */ 'size': number; /** - * The time relevance of the data. + * ticker of the trade * @type {string} - * @memberof GetOptionsChain200ResponseResultsInnerLastTrade + * @memberof GetFuturesTrades200ResponseResultsInner */ - 'timeframe'?: GetOptionsChain200ResponseResultsInnerLastTradeTimeframeEnum; -} - -/** - * @export - * @enum {string} - */ -export enum GetOptionsChain200ResponseResultsInnerLastTradeTimeframeEnum { - Delayed = 'DELAYED', - RealTime = 'REAL-TIME' + 'ticker': string; + /** + * The time when the trade was generated at the exchange to nanosecond precision. + * @type {number} + * @memberof GetFuturesTrades200ResponseResultsInner + */ + 'timestamp': number; } - /** * * @export - * @interface GetOptionsContract200Response + * @interface GetFuturesVXContractsNew200Response */ -export interface GetOptionsContract200Response { +export interface GetFuturesVXContractsNew200Response { + /** + * If present, this value can be used to fetch the next page. + * @type {string} + * @memberof GetFuturesVXContractsNew200Response + */ + 'next_url'?: string; /** * A request id assigned by the server. * @type {string} - * @memberof GetOptionsContract200Response + * @memberof GetFuturesVXContractsNew200Response */ - 'request_id'?: string; + 'request_id': string; /** - * - * @type {ListOptionsContracts200ResponseResultsInner} - * @memberof GetOptionsContract200Response + * The results for this request. + * @type {Array} + * @memberof GetFuturesVXContractsNew200Response */ - 'results'?: ListOptionsContracts200ResponseResultsInner; + 'results': Array; /** * The status of this request\'s response. * @type {string} - * @memberof GetOptionsContract200Response + * @memberof GetFuturesVXContractsNew200Response */ - 'status'?: string; + 'status': GetFuturesVXContractsNew200ResponseStatusEnum; +} + +/** + * @export + * @enum {string} + */ +export enum GetFuturesVXContractsNew200ResponseStatusEnum { + Ok = 'OK' } + /** * * @export - * @interface GetOptionsOpenClose200Response + * @interface GetFuturesVXContractsNew200ResponseResultsInner */ -export interface GetOptionsOpenClose200Response { - /** - * The close price of the ticker symbol in after hours trading. - * @type {number} - * @memberof GetOptionsOpenClose200Response - */ - 'afterHours'?: number; +export interface GetFuturesVXContractsNew200ResponseResultsInner { /** - * The close price for the symbol in the given time period. - * @type {number} - * @memberof GetOptionsOpenClose200Response + * The contract is still trading. + * @type {boolean} + * @memberof GetFuturesVXContractsNew200ResponseResultsInner */ - 'close': number; + 'active': boolean; /** - * The requested date. + * A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about products for the specified day (default=today). * @type {string} - * @memberof GetOptionsOpenClose200Response + * @memberof GetFuturesVXContractsNew200ResponseResultsInner */ - 'from': string; + 'date': string; /** - * The highest price for the symbol in the given time period. + * * @type {number} - * @memberof GetOptionsOpenClose200Response + * @memberof GetFuturesVXContractsNew200ResponseResultsInner */ - 'high': number; + 'days_to_maturity'?: number; /** - * The lowest price for the symbol in the given time period. + * The first date the contract trades. * @type {number} - * @memberof GetOptionsOpenClose200Response + * @memberof GetFuturesVXContractsNew200ResponseResultsInner */ - 'low': number; + 'first_trade_date'?: number; /** - * The open price for the symbol in the given time period. - * @type {number} - * @memberof GetOptionsOpenClose200Response + * + * @type {string} + * @memberof GetFuturesVXContractsNew200ResponseResultsInner */ - 'open': number; + 'group_code'?: string; /** - * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. - * @type {boolean} - * @memberof GetOptionsOpenClose200Response + * + * @type {string} + * @memberof GetFuturesVXContractsNew200ResponseResultsInner */ - 'otc'?: boolean; + 'guid'?: string; /** - * The open price of the ticker symbol in pre-market trading. + * The last date the contract trades. * @type {number} - * @memberof GetOptionsOpenClose200Response + * @memberof GetFuturesVXContractsNew200ResponseResultsInner */ - 'preMarket'?: number; + 'last_trade_date'?: number; /** - * The status of this request\'s response. - * @type {string} - * @memberof GetOptionsOpenClose200Response + * + * @type {boolean} + * @memberof GetFuturesVXContractsNew200ResponseResultsInner */ - 'status': string; + 'latest'?: boolean; /** - * The exchange symbol that this item is traded under. + * * @type {string} - * @memberof GetOptionsOpenClose200Response + * @memberof GetFuturesVXContractsNew200ResponseResultsInner */ - 'symbol': string; + 'maturity_month'?: string; /** - * The trading volume of the symbol in the given time period. - * @type {number} - * @memberof GetOptionsOpenClose200Response + * The maximum order quantity. + * @type {string} + * @memberof GetFuturesVXContractsNew200ResponseResultsInner */ - 'volume': number; -} -/** - * - * @export - * @interface GetOptionsQuotes200Response - */ -export interface GetOptionsQuotes200Response { + 'max_order_quantity'?: string; /** - * If present, this value can be used to fetch the next page of data. + * The minimum order quantity. * @type {string} - * @memberof GetOptionsQuotes200Response + * @memberof GetFuturesVXContractsNew200ResponseResultsInner */ - 'next_url'?: string; + 'min_order_quantity'?: string; /** - * A request id assigned by the server. + * The full name of the product. * @type {string} - * @memberof GetOptionsQuotes200Response + * @memberof GetFuturesVXContractsNew200ResponseResultsInner */ - 'request_id'?: string; + 'name'?: string; /** - * An array of results containing the requested data. - * @type {Array} - * @memberof GetOptionsQuotes200Response + * The unique identifier for the product. + * @type {string} + * @memberof GetFuturesVXContractsNew200ResponseResultsInner */ - 'results'?: Array; + 'product_code'?: string; /** - * The status of this request\'s response. + * * @type {string} - * @memberof GetOptionsQuotes200Response + * @memberof GetFuturesVXContractsNew200ResponseResultsInner */ - 'status': string; -} -/** - * - * @export - * @interface GetOptionsQuotes200ResponseResultsInner - */ -export interface GetOptionsQuotes200ResponseResultsInner { + 'security_id'?: string; /** - * The ask exchange ID + * * @type {number} - * @memberof GetOptionsQuotes200ResponseResultsInner + * @memberof GetFuturesVXContractsNew200ResponseResultsInner */ - 'ask_exchange'?: number; + 'settlement_date'?: number; /** - * The ask price. + * The tick size for settlement. * @type {number} - * @memberof GetOptionsQuotes200ResponseResultsInner + * @memberof GetFuturesVXContractsNew200ResponseResultsInner */ - 'ask_price'?: number; + 'settlement_tick_size'?: number; /** - * The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price. + * The tick size for spreads. * @type {number} - * @memberof GetOptionsQuotes200ResponseResultsInner + * @memberof GetFuturesVXContractsNew200ResponseResultsInner */ - 'ask_size'?: number; + 'spread_tick_size'?: number; /** - * The bid exchange ID - * @type {number} - * @memberof GetOptionsQuotes200ResponseResultsInner + * The ticker for the contract. + * @type {string} + * @memberof GetFuturesVXContractsNew200ResponseResultsInner */ - 'bid_exchange'?: number; + 'ticker'?: string; /** - * The bid price. + * The tick size for trades. * @type {number} - * @memberof GetOptionsQuotes200ResponseResultsInner + * @memberof GetFuturesVXContractsNew200ResponseResultsInner */ - 'bid_price'?: number; + 'trade_tick_size'?: number; /** - * The bid size. This represents the number of round lot orders at the given bid price. The normal round lot size is 100 shares. A bid size of 2 means there are 200 shares for purchase at the given bid price. - * @type {number} - * @memberof GetOptionsQuotes200ResponseResultsInner + * The trading venue (MIC) for the exchange on which this contract trades. + * @type {string} + * @memberof GetFuturesVXContractsNew200ResponseResultsInner */ - 'bid_size'?: number; + 'trading_venue'?: string; /** - * The sequence number represents the sequence in which quote events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). - * @type {number} - * @memberof GetOptionsQuotes200ResponseResultsInner + * The type of product, one of \'single\' or \'combo\'. + * @type {string} + * @memberof GetFuturesVXContractsNew200ResponseResultsInner */ - 'sequence_number': number; + 'type'?: string; /** - * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it. - * @type {number} - * @memberof GetOptionsQuotes200ResponseResultsInner + * + * @type {string} + * @memberof GetFuturesVXContractsNew200ResponseResultsInner */ - 'sip_timestamp': number; + 'year_month': string; } /** * * @export - * @interface GetOptionsTrades200Response + * @interface GetFuturesVXExchanges200Response */ -export interface GetOptionsTrades200Response { +export interface GetFuturesVXExchanges200Response { /** - * If present, this value can be used to fetch the next page of data. + * If present, this value can be used to fetch the next page. * @type {string} - * @memberof GetOptionsTrades200Response + * @memberof GetFuturesVXExchanges200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} - * @memberof GetOptionsTrades200Response + * @memberof GetFuturesVXExchanges200Response */ - 'request_id'?: string; + 'request_id': string; /** - * An array of results containing the requested data. - * @type {Array} - * @memberof GetOptionsTrades200Response + * The results for this request. + * @type {Array} + * @memberof GetFuturesVXExchanges200Response */ - 'results'?: Array; + 'results': Array; /** * The status of this request\'s response. * @type {string} - * @memberof GetOptionsTrades200Response + * @memberof GetFuturesVXExchanges200Response */ - 'status': string; + 'status': GetFuturesVXExchanges200ResponseStatusEnum; +} + +/** + * @export + * @enum {string} + */ +export enum GetFuturesVXExchanges200ResponseStatusEnum { + Ok = 'OK' } + /** * * @export - * @interface GetOptionsTrades200ResponseResultsInner + * @interface GetFuturesVXExchanges200ResponseResultsInner */ -export interface GetOptionsTrades200ResponseResultsInner { +export interface GetFuturesVXExchanges200ResponseResultsInner { /** - * A list of condition codes. - * @type {Array} - * @memberof GetOptionsTrades200ResponseResultsInner + * Well-known acronym for the exchange (e.g., \'CME\', \'NYMEX\', \'CBOT\', \'COMEX\'). + * @type {string} + * @memberof GetFuturesVXExchanges200ResponseResultsInner */ - 'conditions'?: Array; + 'acronym'?: string; /** - * The trade correction indicator. - * @type {number} - * @memberof GetOptionsTrades200ResponseResultsInner + * Numeric identifier for the futures exchange or trading venue. + * @type {string} + * @memberof GetFuturesVXExchanges200ResponseResultsInner */ - 'correction'?: number; + 'id': string; /** - * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. - * @type {number} - * @memberof GetOptionsTrades200ResponseResultsInner + * Geographic location code where the exchange operates. + * @type {string} + * @memberof GetFuturesVXExchanges200ResponseResultsInner */ - 'exchange': number; + 'locale'?: string; /** - * The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the trade was actually generated at the exchange. - * @type {number} - * @memberof GetOptionsTrades200ResponseResultsInner + * Market Identifier Code (MIC) - ISO 10383 standard four-character code for the futures market. + * @type {string} + * @memberof GetFuturesVXExchanges200ResponseResultsInner */ - 'participant_timestamp'?: number; + 'mic'?: string; /** - * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. - * @type {number} - * @memberof GetOptionsTrades200ResponseResultsInner + * Full official name of the futures exchange (e.g., \'Chicago Mercantile Exchange\', \'New York Mercantile Exchange\'). + * @type {string} + * @memberof GetFuturesVXExchanges200ResponseResultsInner */ - 'price': number; + 'name': string; /** - * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this trade from the exchange which produced it. - * @type {number} - * @memberof GetOptionsTrades200ResponseResultsInner + * Operating Market Identifier Code for the futures exchange. + * @type {string} + * @memberof GetFuturesVXExchanges200ResponseResultsInner */ - 'sip_timestamp': number; + 'operating_mic'?: string; /** - * The size of a trade (also known as volume). - * @type {number} - * @memberof GetOptionsTrades200ResponseResultsInner + * Type of venue - \'exchange\' for futures exchanges and derivatives trading platforms. + * @type {string} + * @memberof GetFuturesVXExchanges200ResponseResultsInner */ - 'size': number; + 'type': string; + /** + * Official website URL of the futures exchange organization. + * @type {string} + * @memberof GetFuturesVXExchanges200ResponseResultsInner + */ + 'url'?: string; } /** * * @export - * @interface GetPreviousCryptoAggregates200Response + * @interface GetFuturesVXProductsNew200Response */ -export interface GetPreviousCryptoAggregates200Response { +export interface GetFuturesVXProductsNew200Response { /** - * The exchange symbol that this item is traded under. + * If present, this value can be used to fetch the next page. * @type {string} - * @memberof GetPreviousCryptoAggregates200Response - */ - 'ticker': string; - /** - * Whether or not this response was adjusted for splits. - * @type {boolean} - * @memberof GetPreviousCryptoAggregates200Response - */ - 'adjusted': boolean; - /** - * The number of aggregates (minute or day) used to generate the response. - * @type {number} - * @memberof GetPreviousCryptoAggregates200Response + * @memberof GetFuturesVXProductsNew200Response */ - 'queryCount': number; + 'next_url'?: string; /** * A request id assigned by the server. * @type {string} - * @memberof GetPreviousCryptoAggregates200Response + * @memberof GetFuturesVXProductsNew200Response */ 'request_id': string; /** - * The total number of results for this request. - * @type {number} - * @memberof GetPreviousCryptoAggregates200Response + * The results for this request. + * @type {Array} + * @memberof GetFuturesVXProductsNew200Response */ - 'resultsCount': number; + 'results': Array; /** * The status of this request\'s response. * @type {string} - * @memberof GetPreviousCryptoAggregates200Response + * @memberof GetFuturesVXProductsNew200Response */ - 'status': string; - /** - * An array of results containing the requested data. - * @type {Array} - * @memberof GetPreviousCryptoAggregates200Response - */ - 'results'?: Array; + 'status': GetFuturesVXProductsNew200ResponseStatusEnum; +} + +/** + * @export + * @enum {string} + */ +export enum GetFuturesVXProductsNew200ResponseStatusEnum { + Ok = 'OK' } + /** * * @export - * @interface GetPreviousForexAggregates200Response + * @interface GetFuturesVXProductsNew200ResponseResultsInner */ -export interface GetPreviousForexAggregates200Response { +export interface GetFuturesVXProductsNew200ResponseResultsInner { /** - * The exchange symbol that this item is traded under. + * The asset class to which the product belongs. * @type {string} - * @memberof GetPreviousForexAggregates200Response + * @memberof GetFuturesVXProductsNew200ResponseResultsInner */ - 'ticker': string; + 'asset_class'?: string; /** - * Whether or not this response was adjusted for splits. - * @type {boolean} - * @memberof GetPreviousForexAggregates200Response + * The asset sub-class to which the product belongs. + * @type {string} + * @memberof GetFuturesVXProductsNew200ResponseResultsInner */ - 'adjusted': boolean; + 'asset_sub_class'?: string; /** - * The number of aggregates (minute or day) used to generate the response. + * A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about products for the specified day (default=today). + * @type {string} + * @memberof GetFuturesVXProductsNew200ResponseResultsInner + */ + 'date': string; + /** + * * @type {number} - * @memberof GetPreviousForexAggregates200Response + * @memberof GetFuturesVXProductsNew200ResponseResultsInner */ - 'queryCount': number; + 'display_factor'?: number; /** - * A request id assigned by the server. + * * @type {string} - * @memberof GetPreviousForexAggregates200Response + * @memberof GetFuturesVXProductsNew200ResponseResultsInner */ - 'request_id': string; + 'group_code'?: string; /** - * The total number of results for this request. + * * @type {number} - * @memberof GetPreviousForexAggregates200Response + * @memberof GetFuturesVXProductsNew200ResponseResultsInner */ - 'resultsCount': number; + 'last_updated'?: number; /** - * The status of this request\'s response. - * @type {string} - * @memberof GetPreviousForexAggregates200Response + * + * @type {boolean} + * @memberof GetFuturesVXProductsNew200ResponseResultsInner */ - 'status': string; + 'latest'?: boolean; /** - * An array of results containing the requested data. - * @type {Array} - * @memberof GetPreviousForexAggregates200Response + * The full name of the product. + * @type {string} + * @memberof GetFuturesVXProductsNew200ResponseResultsInner */ - 'results'?: Array; -} -/** - * - * @export - * @interface GetPreviousForexAggregates200ResponseAllOfResultsInner - */ -export interface GetPreviousForexAggregates200ResponseAllOfResultsInner { + 'name'?: string; /** - * The exchange symbol that this item is traded under. + * The quoted price for this product. * @type {string} - * @memberof GetPreviousForexAggregates200ResponseAllOfResultsInner + * @memberof GetFuturesVXProductsNew200ResponseResultsInner */ - 'T': string; + 'price_quotation'?: string; /** - * The close price for the symbol in the given time period. - * @type {number} - * @memberof GetPreviousForexAggregates200ResponseAllOfResultsInner + * The unique identifier for the product. + * @type {string} + * @memberof GetFuturesVXProductsNew200ResponseResultsInner */ - 'c': number; + 'product_code'?: string; /** - * The highest price for the symbol in the given time period. - * @type {number} - * @memberof GetPreviousForexAggregates200ResponseAllOfResultsInner + * The sector to which the product belongs. + * @type {string} + * @memberof GetFuturesVXProductsNew200ResponseResultsInner */ - 'h': number; + 'sector'?: string; /** - * The lowest price for the symbol in the given time period. - * @type {number} - * @memberof GetPreviousForexAggregates200ResponseAllOfResultsInner + * The currency in which this product settles. + * @type {string} + * @memberof GetFuturesVXProductsNew200ResponseResultsInner */ - 'l': number; + 'settlement_currency_code'?: string; /** - * The number of transactions in the aggregate window. - * @type {number} - * @memberof GetPreviousForexAggregates200ResponseAllOfResultsInner + * The method of settlement for this product (Financially Settled or Deliverable). + * @type {string} + * @memberof GetFuturesVXProductsNew200ResponseResultsInner */ - 'n'?: number; + 'settlement_method'?: string; /** - * The open price for the symbol in the given time period. - * @type {number} - * @memberof GetPreviousForexAggregates200ResponseAllOfResultsInner + * The type of settlement for this product. + * @type {string} + * @memberof GetFuturesVXProductsNew200ResponseResultsInner */ - 'o': number; + 'settlement_type'?: string; /** - * The Unix millisecond timestamp for the start of the aggregate window. - * @type {number} - * @memberof GetPreviousForexAggregates200ResponseAllOfResultsInner + * The sub-sector to which the product belongs. + * @type {string} + * @memberof GetFuturesVXProductsNew200ResponseResultsInner */ - 't': number; + 'sub_sector'?: string; /** - * The trading volume of the symbol in the given time period. - * @type {number} - * @memberof GetPreviousForexAggregates200ResponseAllOfResultsInner + * The currency in which this product trades. + * @type {string} + * @memberof GetFuturesVXProductsNew200ResponseResultsInner */ - 'v': number; + 'trade_currency_code'?: string; /** - * The volume weighted average price. + * The trading venue (MIC) for the exchange on which this contract trades. + * @type {string} + * @memberof GetFuturesVXProductsNew200ResponseResultsInner + */ + 'trading_venue'?: string; + /** + * The type of product, one of \'single\' or \'combo\'. + * @type {string} + * @memberof GetFuturesVXProductsNew200ResponseResultsInner + */ + 'type'?: string; + /** + * The unit of measure for this product. + * @type {string} + * @memberof GetFuturesVXProductsNew200ResponseResultsInner + */ + 'unit_of_measure'?: string; + /** + * The quantity of the unit of measure for this product. * @type {number} - * @memberof GetPreviousForexAggregates200ResponseAllOfResultsInner + * @memberof GetFuturesVXProductsNew200ResponseResultsInner */ - 'vw'?: number; + 'unit_of_measure_qty'?: number; } /** * * @export - * @interface GetPreviousIndicesAggregates200Response + * @interface GetFuturesVXSnapshot200Response */ -export interface GetPreviousIndicesAggregates200Response { +export interface GetFuturesVXSnapshot200Response { /** - * The exchange symbol that this item is traded under. + * If present, this value can be used to fetch the next page. * @type {string} - * @memberof GetPreviousIndicesAggregates200Response - */ - 'ticker': string; - /** - * The number of aggregates (minute or day) used to generate the response. - * @type {number} - * @memberof GetPreviousIndicesAggregates200Response + * @memberof GetFuturesVXSnapshot200Response */ - 'queryCount': number; + 'next_url'?: string; /** * A request id assigned by the server. * @type {string} - * @memberof GetPreviousIndicesAggregates200Response + * @memberof GetFuturesVXSnapshot200Response */ 'request_id': string; /** - * The total number of results for this request. - * @type {number} - * @memberof GetPreviousIndicesAggregates200Response + * The results for this request. + * @type {Array} + * @memberof GetFuturesVXSnapshot200Response */ - 'resultsCount': number; + 'results': Array; /** * The status of this request\'s response. * @type {string} - * @memberof GetPreviousIndicesAggregates200Response - */ - 'status': string; - /** - * An array of results containing the requested data. - * @type {Array} - * @memberof GetPreviousIndicesAggregates200Response + * @memberof GetFuturesVXSnapshot200Response */ - 'results'?: Array; + 'status': GetFuturesVXSnapshot200ResponseStatusEnum; +} + +/** + * @export + * @enum {string} + */ +export enum GetFuturesVXSnapshot200ResponseStatusEnum { + Ok = 'OK' } + /** * * @export - * @interface GetPreviousIndicesAggregates200ResponseAllOfResultsInner + * @interface GetFuturesVXSnapshot200ResponseResultsInner */ -export interface GetPreviousIndicesAggregates200ResponseAllOfResultsInner { +export interface GetFuturesVXSnapshot200ResponseResultsInner { /** - * The close value for the symbol in the given time period. - * @type {number} - * @memberof GetPreviousIndicesAggregates200ResponseAllOfResultsInner + * + * @type {GetFuturesVXSnapshot200ResponseResultsInnerDetails} + * @memberof GetFuturesVXSnapshot200ResponseResultsInner */ - 'c': number; + 'details'?: GetFuturesVXSnapshot200ResponseResultsInnerDetails; /** - * The highest value for the symbol in the given time period. - * @type {number} - * @memberof GetPreviousIndicesAggregates200ResponseAllOfResultsInner + * + * @type {GetFuturesVXSnapshot200ResponseResultsInnerLastMinute} + * @memberof GetFuturesVXSnapshot200ResponseResultsInner */ - 'h': number; + 'last_minute'?: GetFuturesVXSnapshot200ResponseResultsInnerLastMinute; /** - * The lowest value for the symbol in the given time period. - * @type {number} - * @memberof GetPreviousIndicesAggregates200ResponseAllOfResultsInner + * + * @type {GetFuturesVXSnapshot200ResponseResultsInnerLastQuote} + * @memberof GetFuturesVXSnapshot200ResponseResultsInner */ - 'l': number; + 'last_quote'?: GetFuturesVXSnapshot200ResponseResultsInnerLastQuote; /** - * The open value for the symbol in the given time period. - * @type {number} - * @memberof GetPreviousIndicesAggregates200ResponseAllOfResultsInner + * + * @type {GetFuturesVXSnapshot200ResponseResultsInnerLastTrade} + * @memberof GetFuturesVXSnapshot200ResponseResultsInner */ - 'o': number; + 'last_trade'?: GetFuturesVXSnapshot200ResponseResultsInnerLastTrade; /** - * The Unix millisecond timestamp for the start of the aggregate window. - * @type {number} - * @memberof GetPreviousIndicesAggregates200ResponseAllOfResultsInner + * + * @type {GetFuturesVXSnapshot200ResponseResultsInnerSession} + * @memberof GetFuturesVXSnapshot200ResponseResultsInner */ - 't': number; + 'session'?: GetFuturesVXSnapshot200ResponseResultsInnerSession; } /** * * @export - * @interface GetRelatedCompanies200Response + * @interface GetFuturesVXSnapshot200ResponseResultsInnerDetails */ -export interface GetRelatedCompanies200Response { +export interface GetFuturesVXSnapshot200ResponseResultsInnerDetails { /** - * A request id assigned by the server. + * * @type {string} - * @memberof GetRelatedCompanies200Response - */ - 'request_id'?: string; - /** - * An array of results containing the requested data. - * @type {Array} - * @memberof GetRelatedCompanies200Response + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerDetails */ - 'results'?: Array; + 'product_code'?: string; /** - * The status of this request\'s response. - * @type {string} - * @memberof GetRelatedCompanies200Response + * The day that this contract is settled. + * @type {number} + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerDetails */ - 'status'?: string; + 'settlement_date'?: number; /** - * The ticker being queried. + * * @type {string} - * @memberof GetRelatedCompanies200Response + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerDetails */ 'ticker'?: string; } /** - * The tickers related to the requested ticker. + * * @export - * @interface GetRelatedCompanies200ResponseResultsInner + * @interface GetFuturesVXSnapshot200ResponseResultsInnerLastMinute */ -export interface GetRelatedCompanies200ResponseResultsInner { +export interface GetFuturesVXSnapshot200ResponseResultsInnerLastMinute { /** - * A ticker related to the requested ticker. - * @type {string} - * @memberof GetRelatedCompanies200ResponseResultsInner + * The price at the end of the minute bar. + * @type {number} + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerLastMinute */ - 'ticker': string; -} -/** - * - * @export - * @interface GetSnapshotSummary200Response - */ -export interface GetSnapshotSummary200Response { + 'close'?: number; /** - * A request id assigned by the server. - * @type {string} - * @memberof GetSnapshotSummary200Response + * The highest price reached in the minute bar. + * @type {number} + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerLastMinute */ - 'request_id': string; + 'high'?: number; /** - * An array of results containing the requested data. - * @type {Array} - * @memberof GetSnapshotSummary200Response + * The timestamp indicating the most recent update to the minute bar. + * @type {number} + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerLastMinute */ - 'results'?: Array; + 'last_updated'?: number; /** - * The status of this request\'s response. + * The lowest price reached in the minute bar. + * @type {number} + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerLastMinute + */ + 'low'?: number; + /** + * The opening price at the start of the minute bar. + * @type {number} + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerLastMinute + */ + 'open'?: number; + /** + * * @type {string} - * @memberof GetSnapshotSummary200Response + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerLastMinute */ - 'status': string; + 'timeframe'?: string; + /** + * The number of contracts traded in the minute bar. + * @type {number} + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerLastMinute + */ + 'volume'?: number; } /** * * @export - * @interface GetSnapshotSummary200ResponseResultsInner + * @interface GetFuturesVXSnapshot200ResponseResultsInnerLastQuote */ -export interface GetSnapshotSummary200ResponseResultsInner { +export interface GetFuturesVXSnapshot200ResponseResultsInnerLastQuote { /** - * - * @type {GetSnapshotSummary200ResponseResultsInnerBranding} - * @memberof GetSnapshotSummary200ResponseResultsInner + * The lowest price a seller is willing to accept. + * @type {number} + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerLastQuote */ - 'branding'?: GetSnapshotSummary200ResponseResultsInnerBranding; + 'ask'?: number; /** - * The error while looking for this ticker. - * @type {string} - * @memberof GetSnapshotSummary200ResponseResultsInner + * The number of contracts available at the ask price. + * @type {number} + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerLastQuote */ - 'error'?: string; + 'ask_size'?: number; /** - * The nanosecond timestamp of when this information was updated. + * The time when the best ask price was last updated. * @type {number} - * @memberof GetSnapshotSummary200ResponseResultsInner + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerLastQuote */ - 'last_updated'?: number; + 'ask_timestamp'?: number; /** - * The market status for the market that trades this ticker. - * @type {string} - * @memberof GetSnapshotSummary200ResponseResultsInner + * The highest price a buyer is willing to pay. + * @type {number} + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerLastQuote */ - 'market_status'?: string; + 'bid'?: number; /** - * The error message while looking for this ticker. - * @type {string} - * @memberof GetSnapshotSummary200ResponseResultsInner + * The number of contracts available at the bid price. + * @type {number} + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerLastQuote */ - 'message'?: string; + 'bid_size'?: number; /** - * Name of ticker, forex, or crypto asset. - * @type {string} - * @memberof GetSnapshotSummary200ResponseResultsInner + * The time when the best bid price was last updated. + * @type {number} + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerLastQuote */ - 'name'?: string; + 'bid_timestamp'?: number; + /** + * The time when the quote was generated at the exchange to nanosecond precision. + * @type {number} + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerLastQuote + */ + 'last_updated'?: number; /** * - * @type {GetSnapshotSummary200ResponseResultsInnerOptions} - * @memberof GetSnapshotSummary200ResponseResultsInner + * @type {string} + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerLastQuote */ - 'options'?: GetSnapshotSummary200ResponseResultsInnerOptions; + 'timeframe'?: string; +} +/** + * + * @export + * @interface GetFuturesVXSnapshot200ResponseResultsInnerLastTrade + */ +export interface GetFuturesVXSnapshot200ResponseResultsInnerLastTrade { /** - * The most up to date ticker price. + * The time when the trade was generated at the exchange to nanosecond precision. * @type {number} - * @memberof GetSnapshotSummary200ResponseResultsInner + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerLastTrade */ - 'price'?: number; + 'last_updated'?: number; /** - * - * @type {GetSnapshotSummary200ResponseResultsInnerSession} - * @memberof GetSnapshotSummary200ResponseResultsInner + * The price of the trade. This is the actual dollar value per whole contract of this trade. A trade of 100 contracts with a price of $2.00 would be worth a total dollar value of $200.00. + * @type {number} + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerLastTrade */ - 'session'?: GetSnapshotSummary200ResponseResultsInnerSession; + 'price'?: number; /** - * Ticker of asset queried. - * @type {string} - * @memberof GetSnapshotSummary200ResponseResultsInner + * The total number of contracts exchanged between buyers and sellers on a given trade. + * @type {number} + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerLastTrade */ - 'ticker': string; + 'size'?: number; /** - * The market for this ticker of stock, crypto, fx, option. + * * @type {string} - * @memberof GetSnapshotSummary200ResponseResultsInner + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerLastTrade */ - 'type'?: GetSnapshotSummary200ResponseResultsInnerTypeEnum; + 'timeframe'?: string; } - -/** - * @export - * @enum {string} - */ -export enum GetSnapshotSummary200ResponseResultsInnerTypeEnum { - Stocks = 'stocks', - Crypto = 'crypto', - Options = 'options', - Fx = 'fx' -} - /** * * @export - * @interface GetSnapshotSummary200ResponseResultsInnerBranding + * @interface GetFuturesVXSnapshot200ResponseResultsInnerSession */ -export interface GetSnapshotSummary200ResponseResultsInnerBranding { +export interface GetFuturesVXSnapshot200ResponseResultsInnerSession { /** - * A link to this ticker\'s company\'s icon. Icon\'s are generally smaller, square images that represent the company at a glance. Note that you must provide an API key when accessing this URL. See the \"Authentication\" section at the top of this page for more details. - * @type {string} - * @memberof GetSnapshotSummary200ResponseResultsInnerBranding + * The change in price during this session. + * @type {number} + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerSession */ - 'icon_url'?: string; + 'change'?: number; /** - * A link to this ticker\'s company\'s logo. Note that you must provide an API key when accessing this URL. See the \"Authentication\" section at the top of this page for more details. - * @type {string} - * @memberof GetSnapshotSummary200ResponseResultsInnerBranding + * The percentage change in price during this session. + * @type {number} + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerSession */ - 'logo_url'?: string; -} -/** - * - * @export - * @interface GetSnapshotSummary200ResponseResultsInnerOptions - */ -export interface GetSnapshotSummary200ResponseResultsInnerOptions { + 'change_percent'?: number; /** - * The type of contract. Can be \"put\", \"call\", or in some rare cases, \"other\". - * @type {string} - * @memberof GetSnapshotSummary200ResponseResultsInnerOptions + * The price at the end of the session. + * @type {number} + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerSession */ - 'contract_type': GetSnapshotSummary200ResponseResultsInnerOptionsContractTypeEnum; + 'close'?: number; /** - * The exercise style of this contract. See this link for more details on exercise styles. - * @type {string} - * @memberof GetSnapshotSummary200ResponseResultsInnerOptions + * The highest price reached in the session. + * @type {number} + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerSession */ - 'exercise_style': GetSnapshotSummary200ResponseResultsInnerOptionsExerciseStyleEnum; + 'high'?: number; /** - * The contract\'s expiration date in YYYY-MM-DD format. - * @type {string} - * @memberof GetSnapshotSummary200ResponseResultsInnerOptions + * The lowest price reached in the session. + * @type {number} + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerSession */ - 'expiration_date': string; + 'low'?: number; /** - * The number of shares per contract for this contract. + * The opening price at the start of the session. * @type {number} - * @memberof GetSnapshotSummary200ResponseResultsInnerOptions + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerSession */ - 'shares_per_contract': number; + 'open'?: number; /** - * The strike price of the option contract. + * The settlement price of the previous session. * @type {number} - * @memberof GetSnapshotSummary200ResponseResultsInnerOptions + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerSession */ - 'strike_price': number; + 'previous_settlement'?: number; /** - * The ticker for the option contract. - * @type {string} - * @memberof GetSnapshotSummary200ResponseResultsInnerOptions + * The final settlement price at the end of the session. + * @type {number} + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerSession */ - 'underlying_ticker': string; -} - -/** - * @export - * @enum {string} - */ -export enum GetSnapshotSummary200ResponseResultsInnerOptionsContractTypeEnum { - Put = 'put', - Call = 'call', - Other = 'other' -} -/** - * @export - * @enum {string} - */ -export enum GetSnapshotSummary200ResponseResultsInnerOptionsExerciseStyleEnum { - American = 'american', - European = 'european', - Bermudan = 'bermudan' + 'settlement_price'?: number; + /** + * The number of contracts traded in the session. + * @type {number} + * @memberof GetFuturesVXSnapshot200ResponseResultsInnerSession + */ + 'volume'?: number; } - /** - * Comprehensive trading session metrics, detailing price changes, trading volume, and key price points (open, close, high, low) for the asset within the current trading day. Includes specific changes during early, regular, and late trading periods to enable detailed performance analysis and trend tracking. + * * @export - * @interface GetSnapshotSummary200ResponseResultsInnerSession + * @interface GetGroupedCryptoAggregates200Response */ -export interface GetSnapshotSummary200ResponseResultsInnerSession { +export interface GetGroupedCryptoAggregates200Response { /** - * The value of the price change for the asset from the previous trading day. - * @type {number} - * @memberof GetSnapshotSummary200ResponseResultsInnerSession + * Whether or not this response was adjusted for splits. + * @type {boolean} + * @memberof GetGroupedCryptoAggregates200Response */ - 'change': number; + 'adjusted': boolean; /** - * The percent of the price change for the asset from the previous trading day. + * The number of aggregates (minute or day) used to generate the response. * @type {number} - * @memberof GetSnapshotSummary200ResponseResultsInnerSession + * @memberof GetGroupedCryptoAggregates200Response */ - 'change_percent': number; + 'queryCount': number; /** - * The closing price of the asset for the day. - * @type {number} - * @memberof GetSnapshotSummary200ResponseResultsInnerSession + * A request id assigned by the server. + * @type {string} + * @memberof GetGroupedCryptoAggregates200Response */ - 'close': number; + 'request_id': string; /** - * Today\'s early trading change amount, difference between price and previous close if in early trading hours, otherwise difference between last price during early trading and previous close. + * The total number of results for this request. * @type {number} - * @memberof GetSnapshotSummary200ResponseResultsInnerSession + * @memberof GetGroupedCryptoAggregates200Response */ - 'early_trading_change'?: number; + 'resultsCount': number; /** - * Today\'s early trading change as a percentage. - * @type {number} - * @memberof GetSnapshotSummary200ResponseResultsInnerSession + * The status of this request\'s response. + * @type {string} + * @memberof GetGroupedCryptoAggregates200Response */ - 'early_trading_change_percent'?: number; + 'status': string; /** - * The highest price of the asset for the day. - * @type {number} - * @memberof GetSnapshotSummary200ResponseResultsInnerSession + * An array of results containing the requested data. + * @type {Array} + * @memberof GetGroupedCryptoAggregates200Response */ - 'high': number; + 'results'?: Array; +} +/** + * + * @export + * @interface GetGroupedCryptoAggregates200ResponseAllOfResultsInner + */ +export interface GetGroupedCryptoAggregates200ResponseAllOfResultsInner { /** - * Today\'s late trading change amount, difference between price and today\'s close if in late trading hours, otherwise difference between last price during late trading and today\'s close. - * @type {number} - * @memberof GetSnapshotSummary200ResponseResultsInnerSession + * The exchange symbol that this item is traded under. + * @type {string} + * @memberof GetGroupedCryptoAggregates200ResponseAllOfResultsInner */ - 'late_trading_change'?: number; + 'T': string; /** - * Today\'s late trading change as a percentage. + * The close price for the symbol in the given time period. * @type {number} - * @memberof GetSnapshotSummary200ResponseResultsInnerSession + * @memberof GetGroupedCryptoAggregates200ResponseAllOfResultsInner */ - 'late_trading_change_percent'?: number; + 'c': number; /** - * The lowest price of the asset for the day. + * The highest price for the symbol in the given time period. * @type {number} - * @memberof GetSnapshotSummary200ResponseResultsInnerSession + * @memberof GetGroupedCryptoAggregates200ResponseAllOfResultsInner */ - 'low': number; + 'h': number; /** - * The open price of the asset for the day. + * The lowest price for the symbol in the given time period. * @type {number} - * @memberof GetSnapshotSummary200ResponseResultsInnerSession + * @memberof GetGroupedCryptoAggregates200ResponseAllOfResultsInner */ - 'open': number; + 'l': number; /** - * The closing price of the asset for the previous trading day. + * The number of transactions in the aggregate window. * @type {number} - * @memberof GetSnapshotSummary200ResponseResultsInnerSession + * @memberof GetGroupedCryptoAggregates200ResponseAllOfResultsInner */ - 'previous_close': number; + 'n'?: number; /** - * The price of the most recent trade or bid price for this asset. + * The open price for the symbol in the given time period. * @type {number} - * @memberof GetSnapshotSummary200ResponseResultsInnerSession + * @memberof GetGroupedCryptoAggregates200ResponseAllOfResultsInner */ - 'price'?: number; + 'o': number; /** - * Today\'s change in regular trading hours, difference between current price and previous trading day\'s close, otherwise difference between today\'s close and previous day\'s close. + * The Unix millisecond timestamp for the end of the aggregate window. * @type {number} - * @memberof GetSnapshotSummary200ResponseResultsInnerSession + * @memberof GetGroupedCryptoAggregates200ResponseAllOfResultsInner */ - 'regular_trading_change'?: number; + 't': number; /** - * Today\'s regular trading change as a percentage. + * The trading volume of the symbol in the given time period. * @type {number} - * @memberof GetSnapshotSummary200ResponseResultsInnerSession + * @memberof GetGroupedCryptoAggregates200ResponseAllOfResultsInner */ - 'regular_trading_change_percent'?: number; + 'v': number; /** - * The trading volume for the asset for the day. + * The volume weighted average price. * @type {number} - * @memberof GetSnapshotSummary200ResponseResultsInnerSession + * @memberof GetGroupedCryptoAggregates200ResponseAllOfResultsInner */ - 'volume'?: number; + 'vw'?: number; } /** * * @export - * @interface GetSnapshots200Response + * @interface GetGroupedStocksAggregates200Response */ -export interface GetSnapshots200Response { +export interface GetGroupedStocksAggregates200Response { /** - * If present, this value can be used to fetch the next page of data. - * @type {string} - * @memberof GetSnapshots200Response + * Whether or not this response was adjusted for splits. + * @type {boolean} + * @memberof GetGroupedStocksAggregates200Response */ - 'next_url'?: string; + 'adjusted': boolean; + /** + * The number of aggregates (minute or day) used to generate the response. + * @type {number} + * @memberof GetGroupedStocksAggregates200Response + */ + 'queryCount': number; /** * A request id assigned by the server. * @type {string} - * @memberof GetSnapshots200Response + * @memberof GetGroupedStocksAggregates200Response */ 'request_id': string; /** - * An array of results containing the requested data. - * @type {Array} - * @memberof GetSnapshots200Response + * The total number of results for this request. + * @type {number} + * @memberof GetGroupedStocksAggregates200Response */ - 'results'?: Array; + 'resultsCount': number; /** * The status of this request\'s response. * @type {string} - * @memberof GetSnapshots200Response + * @memberof GetGroupedStocksAggregates200Response */ 'status': string; + /** + * An array of results containing the requested data. + * @type {Array} + * @memberof GetGroupedStocksAggregates200Response + */ + 'results'?: Array; } /** * * @export - * @interface GetSnapshots200ResponseResultsInner + * @interface GetGroupedStocksAggregates200ResponseAllOfResultsInner */ -export interface GetSnapshots200ResponseResultsInner { +export interface GetGroupedStocksAggregates200ResponseAllOfResultsInner { /** - * The price of the underlying asset for the contract to break even. For a call, this value is (strike price + premium paid). For a put, this value is (strike price - premium paid). - * @type {number} - * @memberof GetSnapshots200ResponseResultsInner + * The exchange symbol that this item is traded under. + * @type {string} + * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner */ - 'break_even_price'?: number; + 'T': string; /** - * - * @type {GetSnapshots200ResponseResultsInnerDetails} - * @memberof GetSnapshots200ResponseResultsInner + * The close price for the symbol in the given time period. + * @type {number} + * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner */ - 'details'?: GetSnapshots200ResponseResultsInnerDetails; + 'c': number; /** - * The error while looking for this ticker. + * The highest price for the symbol in the given time period. + * @type {number} + * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner + */ + 'h': number; + /** + * The lowest price for the symbol in the given time period. + * @type {number} + * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner + */ + 'l': number; + /** + * The number of transactions in the aggregate window. + * @type {number} + * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner + */ + 'n'?: number; + /** + * The open price for the symbol in the given time period. + * @type {number} + * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner + */ + 'o': number; + /** + * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. + * @type {boolean} + * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner + */ + 'otc'?: boolean; + /** + * The Unix millisecond timestamp for the end of the aggregate window. + * @type {number} + * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner + */ + 't': number; + /** + * The trading volume of the symbol in the given time period. + * @type {number} + * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner + */ + 'v': number; + /** + * The volume weighted average price. + * @type {number} + * @memberof GetGroupedStocksAggregates200ResponseAllOfResultsInner + */ + 'vw'?: number; +} +/** + * + * @export + * @interface GetIndicesOpenClose200Response + */ +export interface GetIndicesOpenClose200Response { + /** + * The close value of the ticker symbol in after hours trading. + * @type {number} + * @memberof GetIndicesOpenClose200Response + */ + 'afterHours'?: number; + /** + * The close value for the symbol in the given time period. + * @type {number} + * @memberof GetIndicesOpenClose200Response + */ + 'close': number; + /** + * The requested date. * @type {string} - * @memberof GetSnapshots200ResponseResultsInner + * @memberof GetIndicesOpenClose200Response */ - 'error'?: string; + 'from': string; /** - * Fair market value is only available on Business plans. It\'s it our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us. + * The highest value for the symbol in the given time period. * @type {number} - * @memberof GetSnapshots200ResponseResultsInner + * @memberof GetIndicesOpenClose200Response */ - 'fmv'?: number; + 'high': number; /** - * - * @type {GetSnapshots200ResponseResultsInnerGreeks} - * @memberof GetSnapshots200ResponseResultsInner + * The lowest value for the symbol in the given time period. + * @type {number} + * @memberof GetIndicesOpenClose200Response */ - 'greeks'?: GetSnapshots200ResponseResultsInnerGreeks; + 'low': number; /** - * The market\'s forecast for the volatility of the underlying asset, based on this option\'s current price. + * The open value for the symbol in the given time period. * @type {number} - * @memberof GetSnapshots200ResponseResultsInner + * @memberof GetIndicesOpenClose200Response */ - 'implied_volatility'?: number; + 'open': number; /** - * - * @type {GetSnapshots200ResponseResultsInnerLastMinute} - * @memberof GetSnapshots200ResponseResultsInner + * The open value of the ticker symbol in pre-market trading. + * @type {number} + * @memberof GetIndicesOpenClose200Response */ - 'last_minute'?: GetSnapshots200ResponseResultsInnerLastMinute; + 'preMarket'?: number; /** - * - * @type {GetSnapshots200ResponseResultsInnerLastQuote} - * @memberof GetSnapshots200ResponseResultsInner + * The status of this request\'s response. + * @type {string} + * @memberof GetIndicesOpenClose200Response */ - 'last_quote'?: GetSnapshots200ResponseResultsInnerLastQuote; + 'status': string; /** - * - * @type {GetSnapshots200ResponseResultsInnerLastTrade} - * @memberof GetSnapshots200ResponseResultsInner + * The exchange symbol that this item is traded under. + * @type {string} + * @memberof GetIndicesOpenClose200Response */ - 'last_trade'?: GetSnapshots200ResponseResultsInnerLastTrade; + 'symbol': string; +} +/** + * + * @export + * @interface GetIndicesSnapshot200Response + */ +export interface GetIndicesSnapshot200Response { + /** + * If present, this value can be used to fetch the next page of data. + * @type {string} + * @memberof GetIndicesSnapshot200Response + */ + 'next_url'?: string; + /** + * A request id assigned by the server. + * @type {string} + * @memberof GetIndicesSnapshot200Response + */ + 'request_id': string; + /** + * An array of results containing the requested data. + * @type {Array} + * @memberof GetIndicesSnapshot200Response + */ + 'results'?: Array; + /** + * The status of this request\'s response. + * @type {string} + * @memberof GetIndicesSnapshot200Response + */ + 'status': string; +} +/** + * + * @export + * @interface GetIndicesSnapshot200ResponseResultsInner + */ +export interface GetIndicesSnapshot200ResponseResultsInner { + /** + * The error while looking for this ticker. + * @type {string} + * @memberof GetIndicesSnapshot200ResponseResultsInner + */ + 'error'?: string; /** * The nanosecond timestamp of when this information was updated. * @type {number} - * @memberof GetSnapshots200ResponseResultsInner + * @memberof GetIndicesSnapshot200ResponseResultsInner */ 'last_updated'?: number; /** - * The market status for the market that trades this ticker. Possible values for stocks, options, crypto, and forex snapshots are open, closed, early_trading, or late_trading. Possible values for indices snapshots are regular_trading, closed, early_trading, and late_trading. + * The market status for the market that trades this ticker. * @type {string} - * @memberof GetSnapshots200ResponseResultsInner + * @memberof GetIndicesSnapshot200ResponseResultsInner */ 'market_status'?: string; /** * The error message while looking for this ticker. * @type {string} - * @memberof GetSnapshots200ResponseResultsInner + * @memberof GetIndicesSnapshot200ResponseResultsInner */ 'message'?: string; /** - * The name of this contract. + * Name of Index. * @type {string} - * @memberof GetSnapshots200ResponseResultsInner + * @memberof GetIndicesSnapshot200ResponseResultsInner */ 'name'?: string; - /** - * The quantity of this contract held at the end of the last trading day. - * @type {number} - * @memberof GetSnapshots200ResponseResultsInner - */ - 'open_interest'?: number; /** * - * @type {GetSnapshotSummary200ResponseResultsInnerSession} - * @memberof GetSnapshots200ResponseResultsInner + * @type {GetIndicesSnapshot200ResponseResultsInnerSession} + * @memberof GetIndicesSnapshot200ResponseResultsInner */ - 'session'?: GetSnapshotSummary200ResponseResultsInnerSession; + 'session'?: GetIndicesSnapshot200ResponseResultsInnerSession; /** - * The ticker symbol for the asset. + * Ticker of asset queried. * @type {string} - * @memberof GetSnapshots200ResponseResultsInner + * @memberof GetIndicesSnapshot200ResponseResultsInner */ 'ticker': string; /** * The time relevance of the data. * @type {string} - * @memberof GetSnapshots200ResponseResultsInner + * @memberof GetIndicesSnapshot200ResponseResultsInner */ - 'timeframe'?: GetSnapshots200ResponseResultsInnerTimeframeEnum; + 'timeframe'?: GetIndicesSnapshot200ResponseResultsInnerTimeframeEnum; /** - * The asset class for this ticker. + * The indices market. * @type {string} - * @memberof GetSnapshots200ResponseResultsInner - */ - 'type'?: GetSnapshots200ResponseResultsInnerTypeEnum; - /** - * - * @type {GetSnapshots200ResponseResultsInnerUnderlyingAsset} - * @memberof GetSnapshots200ResponseResultsInner + * @memberof GetIndicesSnapshot200ResponseResultsInner */ - 'underlying_asset'?: GetSnapshots200ResponseResultsInnerUnderlyingAsset; + 'type'?: GetIndicesSnapshot200ResponseResultsInnerTypeEnum; /** * Value of Index. * @type {number} - * @memberof GetSnapshots200ResponseResultsInner + * @memberof GetIndicesSnapshot200ResponseResultsInner */ 'value'?: number; } @@ -8218,7 +8407,7 @@ export interface GetSnapshots200ResponseResultsInner { * @export * @enum {string} */ -export enum GetSnapshots200ResponseResultsInnerTimeframeEnum { +export enum GetIndicesSnapshot200ResponseResultsInnerTimeframeEnum { Delayed = 'DELAYED', RealTime = 'REAL-TIME' } @@ -8226,4716 +8415,10068 @@ export enum GetSnapshots200ResponseResultsInnerTimeframeEnum { * @export * @enum {string} */ -export enum GetSnapshots200ResponseResultsInnerTypeEnum { - Stocks = 'stocks', - Options = 'options', - Fx = 'fx', - Crypto = 'crypto', +export enum GetIndicesSnapshot200ResponseResultsInnerTypeEnum { Indices = 'indices' } /** - * The details for this contract. + * Trading session metrics, detailing change percentages and key price points (open, close, high, low) for the asset within the current trading day. * @export - * @interface GetSnapshots200ResponseResultsInnerDetails + * @interface GetIndicesSnapshot200ResponseResultsInnerSession */ -export interface GetSnapshots200ResponseResultsInnerDetails { +export interface GetIndicesSnapshot200ResponseResultsInnerSession { /** - * The type of contract. Can be \"put\", \"call\", or in some rare cases, \"other\". - * @type {string} - * @memberof GetSnapshots200ResponseResultsInnerDetails + * The value of the change for the index from the previous trading day. + * @type {number} + * @memberof GetIndicesSnapshot200ResponseResultsInnerSession */ - 'contract_type': GetSnapshots200ResponseResultsInnerDetailsContractTypeEnum; + 'change'?: number; /** - * The exercise style of this contract. See this link for more details on exercise styles. - * @type {string} - * @memberof GetSnapshots200ResponseResultsInnerDetails + * The percent of the change for the index from the previous trading day. + * @type {number} + * @memberof GetIndicesSnapshot200ResponseResultsInnerSession */ - 'exercise_style': GetSnapshots200ResponseResultsInnerDetailsExerciseStyleEnum; + 'change_percent'?: number; /** - * The contract\'s expiration date in YYYY-MM-DD format. - * @type {string} - * @memberof GetSnapshots200ResponseResultsInnerDetails + * The closing value for the index of the day. + * @type {number} + * @memberof GetIndicesSnapshot200ResponseResultsInnerSession */ - 'expiration_date': string; + 'close'?: number; /** - * The number of shares per contract for this contract. + * The highest value for the index of the day. * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerDetails + * @memberof GetIndicesSnapshot200ResponseResultsInnerSession */ - 'shares_per_contract': number; + 'high'?: number; /** - * The strike price of the option contract. + * The lowest value for the index of the day. * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerDetails + * @memberof GetIndicesSnapshot200ResponseResultsInnerSession */ - 'strike_price': number; -} - -/** - * @export - * @enum {string} - */ -export enum GetSnapshots200ResponseResultsInnerDetailsContractTypeEnum { - Put = 'put', - Call = 'call', - Other = 'other' -} -/** - * @export - * @enum {string} - */ -export enum GetSnapshots200ResponseResultsInnerDetailsExerciseStyleEnum { - American = 'american', - European = 'european', - Bermudan = 'bermudan' + 'low'?: number; + /** + * The open value for the index of the day. + * @type {number} + * @memberof GetIndicesSnapshot200ResponseResultsInnerSession + */ + 'open'?: number; + /** + * The closing value for the index of previous trading day. + * @type {number} + * @memberof GetIndicesSnapshot200ResponseResultsInnerSession + */ + 'previous_close'?: number; } - /** - * The greeks for this contract. There are certain circumstances where greeks will not be returned, such as options contracts that are deep in the money. See this article for more information. + * * @export - * @interface GetSnapshots200ResponseResultsInnerGreeks + * @interface GetLastCryptoTrade200Response */ -export interface GetSnapshots200ResponseResultsInnerGreeks { +export interface GetLastCryptoTrade200Response { /** - * The change in the option\'s price per $0.01 increment in the price of the underlying asset. - * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerGreeks + * + * @type {GetLastCryptoTrade200ResponseLast} + * @memberof GetLastCryptoTrade200Response */ - 'delta': number; + 'last'?: GetLastCryptoTrade200ResponseLast; /** - * The change in delta per $0.01 change in the price of the underlying asset. - * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerGreeks + * A request id assigned by the server. + * @type {string} + * @memberof GetLastCryptoTrade200Response */ - 'gamma': number; + 'request_id': string; /** - * The change in the option\'s price per day. - * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerGreeks + * The status of this request\'s response. + * @type {string} + * @memberof GetLastCryptoTrade200Response */ - 'theta': number; + 'status': string; /** - * The change in the option\'s price per 1% increment in volatility. - * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerGreeks + * The symbol pair that was evaluated from the request. + * @type {string} + * @memberof GetLastCryptoTrade200Response */ - 'vega': number; + 'symbol': string; } /** - * The most recent minute aggregate for this stock. + * Contains the requested trade data for the specified cryptocurrency pair. * @export - * @interface GetSnapshots200ResponseResultsInnerLastMinute + * @interface GetLastCryptoTrade200ResponseLast */ -export interface GetSnapshots200ResponseResultsInnerLastMinute { - /** - * The closing value for the minute aggreate. - * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerLastMinute - */ - 'close': number; - /** - * The highest value for the minute aggregate. - * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerLastMinute - */ - 'high': number; +export interface GetLastCryptoTrade200ResponseLast { /** - * The lowest value for the minute aggregate. - * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerLastMinute + * A list of condition codes. + * @type {Array} + * @memberof GetLastCryptoTrade200ResponseLast */ - 'low': number; + 'conditions'?: Array; /** - * The open value for the minute aggregate. + * The exchange that this crypto trade happened on. See Exchanges for a mapping of exchanges to IDs. * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerLastMinute + * @memberof GetLastCryptoTrade200ResponseLast */ - 'open': number; + 'exchange': number; /** - * The number of transactions that took place within the minute aggregate. + * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerLastMinute + * @memberof GetLastCryptoTrade200ResponseLast */ - 'transactions': number; + 'price': number; /** - * The trading volume for the minute aggregate. + * The size of a trade (also known as volume). * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerLastMinute + * @memberof GetLastCryptoTrade200ResponseLast */ - 'volume': number; + 'size': number; /** - * The trading volume weighted average price for the minute aggregate. + * The Unix millisecond timestamp. * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerLastMinute + * @memberof GetLastCryptoTrade200ResponseLast */ - 'vwap': number; + 'timestamp': number; } /** - * The most recent quote for this contract. This is only returned if your current plan includes quotes. + * * @export - * @interface GetSnapshots200ResponseResultsInnerLastQuote + * @interface GetLastCurrencyQuote200Response */ -export interface GetSnapshots200ResponseResultsInnerLastQuote { - /** - * The ask price. - * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerLastQuote - */ - 'ask': number; - /** - * The ask side exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. - * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerLastQuote - */ - 'ask_exchange'?: number; +export interface GetLastCurrencyQuote200Response { /** - * The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price. - * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerLastQuote + * + * @type {GetCurrencyConversion200ResponseLast} + * @memberof GetLastCurrencyQuote200Response */ - 'ask_size'?: number; + 'last'?: GetCurrencyConversion200ResponseLast; /** - * The bid price. - * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerLastQuote + * A request id assigned by the server. + * @type {string} + * @memberof GetLastCurrencyQuote200Response */ - 'bid': number; + 'request_id': string; /** - * The bid side exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. - * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerLastQuote + * The status of this request\'s response. + * @type {string} + * @memberof GetLastCurrencyQuote200Response */ - 'bid_exchange'?: number; + 'status': string; /** - * The bid size. This represents the number of round lot orders at the given bid price. The normal round lot size is 100 shares. A bid size of 2 means there are 200 shares for purchase at the given bid price. - * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerLastQuote + * The symbol pair that was evaluated from the request. + * @type {string} + * @memberof GetLastCurrencyQuote200Response */ - 'bid_size'?: number; + 'symbol': string; +} +/** + * + * @export + * @interface GetLastOptionsTrade200Response + */ +export interface GetLastOptionsTrade200Response { /** - * The nanosecond timestamp of when this information was updated. - * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerLastQuote + * A request id assigned by the server. + * @type {string} + * @memberof GetLastOptionsTrade200Response */ - 'last_updated': number; + 'request_id': string; /** - * The average of the bid and ask price. - * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerLastQuote + * + * @type {GetLastOptionsTrade200ResponseResults} + * @memberof GetLastOptionsTrade200Response */ - 'midpoint'?: number; + 'results'?: GetLastOptionsTrade200ResponseResults; /** - * The time relevance of the data. + * The status of this request\'s response. * @type {string} - * @memberof GetSnapshots200ResponseResultsInnerLastQuote + * @memberof GetLastOptionsTrade200Response */ - 'timeframe': GetSnapshots200ResponseResultsInnerLastQuoteTimeframeEnum; -} - -/** - * @export - * @enum {string} - */ -export enum GetSnapshots200ResponseResultsInnerLastQuoteTimeframeEnum { - Delayed = 'DELAYED', - RealTime = 'REAL-TIME' + 'status': string; } - /** - * The most recent quote for this contract. This is only returned if your current plan includes trades. + * * @export - * @interface GetSnapshots200ResponseResultsInnerLastTrade + * @interface GetLastOptionsTrade200ResponseResults */ -export interface GetSnapshots200ResponseResultsInnerLastTrade { +export interface GetLastOptionsTrade200ResponseResults { + /** + * The exchange symbol that this item is traded under. + * @type {string} + * @memberof GetLastOptionsTrade200ResponseResults + */ + 'T': string; /** * A list of condition codes. * @type {Array} - * @memberof GetSnapshots200ResponseResultsInnerLastTrade + * @memberof GetLastOptionsTrade200ResponseResults */ - 'conditions'?: Array; + 'c'?: Array; /** - * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. + * The trade correction indicator. * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerLastTrade + * @memberof GetLastOptionsTrade200ResponseResults */ - 'exchange'?: number; + 'e'?: number; + /** + * The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message. + * @type {number} + * @memberof GetLastOptionsTrade200ResponseResults + */ + 'f'?: number; /** * The Trade ID which uniquely identifies a trade. These are unique per combination of ticker, exchange, and TRF. For example: A trade for AAPL executed on NYSE and a trade for AAPL executed on NASDAQ could potentially have the same Trade ID. * @type {string} - * @memberof GetSnapshots200ResponseResultsInnerLastTrade + * @memberof GetLastOptionsTrade200ResponseResults */ - 'id'?: string; + 'i': string; /** - * The nanosecond timestamp of when this information was updated. + * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerLastTrade + * @memberof GetLastOptionsTrade200ResponseResults */ - 'last_updated'?: number; + 'p': number; /** - * The nanosecond Exchange Unix Timestamp. This is the timestamp of when the trade was generated at the exchange. + * The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerLastTrade + * @memberof GetLastOptionsTrade200ResponseResults */ - 'participant_timestamp'?: number; + 'q': number; /** - * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. + * The ID for the Trade Reporting Facility where the trade took place. * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerLastTrade + * @memberof GetLastOptionsTrade200ResponseResults */ - 'price': number; - /** - * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this trade from the exchange which produced it. - * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerLastTrade - */ - 'sip_timestamp'?: number; + 'r'?: number; /** * The size of a trade (also known as volume). * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerLastTrade - */ - 'size': number; - /** - * The time relevance of the data. - * @type {string} - * @memberof GetSnapshots200ResponseResultsInnerLastTrade + * @memberof GetLastOptionsTrade200ResponseResults */ - 'timeframe'?: GetSnapshots200ResponseResultsInnerLastTradeTimeframeEnum; -} - -/** - * @export - * @enum {string} - */ -export enum GetSnapshots200ResponseResultsInnerLastTradeTimeframeEnum { - Delayed = 'DELAYED', - RealTime = 'REAL-TIME' -} - -/** - * Information on the underlying stock for this options contract. The market data returned depends on your current stocks plan. - * @export - * @interface GetSnapshots200ResponseResultsInnerUnderlyingAsset - */ -export interface GetSnapshots200ResponseResultsInnerUnderlyingAsset { + 's'?: number; /** - * The change in price for the contract to break even. + * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerUnderlyingAsset + * @memberof GetLastOptionsTrade200ResponseResults */ - 'change_to_break_even': number; + 't': number; /** - * The nanosecond timestamp of when this information was updated. + * The exchange ID. See Exchanges for Massive.com\'s mapping of exchange IDs. * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerUnderlyingAsset + * @memberof GetLastOptionsTrade200ResponseResults */ - 'last_updated'?: number; + 'x': number; /** - * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. + * The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange. * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerUnderlyingAsset - */ - 'price'?: number; - /** - * The ticker symbol for the contract\'s underlying asset. - * @type {string} - * @memberof GetSnapshots200ResponseResultsInnerUnderlyingAsset - */ - 'ticker': string; - /** - * The time relevance of the data. - * @type {string} - * @memberof GetSnapshots200ResponseResultsInnerUnderlyingAsset + * @memberof GetLastOptionsTrade200ResponseResults */ - 'timeframe'?: GetSnapshots200ResponseResultsInnerUnderlyingAssetTimeframeEnum; + 'y': number; /** - * The value of the underlying index. + * There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C. * Tape A is NYSE listed securities * Tape B is NYSE ARCA / NYSE American * Tape C is NASDAQ * @type {number} - * @memberof GetSnapshots200ResponseResultsInnerUnderlyingAsset + * @memberof GetLastOptionsTrade200ResponseResults */ - 'value'?: number; -} - -/** - * @export - * @enum {string} - */ -export enum GetSnapshots200ResponseResultsInnerUnderlyingAssetTimeframeEnum { - Delayed = 'DELAYED', - RealTime = 'REAL-TIME' + 'z'?: number; } - /** * * @export - * @interface GetStocksAggregates200Response + * @interface GetLastStocksQuote200Response */ -export interface GetStocksAggregates200Response { - /** - * The exchange symbol that this item is traded under. - * @type {string} - * @memberof GetStocksAggregates200Response - */ - 'ticker': string; - /** - * Whether or not this response was adjusted for splits. - * @type {boolean} - * @memberof GetStocksAggregates200Response - */ - 'adjusted': boolean; - /** - * The number of aggregates (minute or day) used to generate the response. - * @type {number} - * @memberof GetStocksAggregates200Response - */ - 'queryCount': number; +export interface GetLastStocksQuote200Response { /** * A request id assigned by the server. * @type {string} - * @memberof GetStocksAggregates200Response + * @memberof GetLastStocksQuote200Response */ 'request_id': string; /** - * The total number of results for this request. - * @type {number} - * @memberof GetStocksAggregates200Response + * + * @type {GetLastStocksQuote200ResponseResults} + * @memberof GetLastStocksQuote200Response */ - 'resultsCount': number; + 'results'?: GetLastStocksQuote200ResponseResults; /** * The status of this request\'s response. * @type {string} - * @memberof GetStocksAggregates200Response + * @memberof GetLastStocksQuote200Response */ 'status': string; - /** - * An array of results containing the requested data. - * @type {Array} - * @memberof GetStocksAggregates200Response - */ - 'results'?: Array; - /** - * If present, this value can be used to fetch the next page of data. - * @type {string} - * @memberof GetStocksAggregates200Response - */ - 'next_url'?: string; } /** * * @export - * @interface GetStocksAggregates200ResponseAllOfResultsInner + * @interface GetLastStocksQuote200ResponseResults */ -export interface GetStocksAggregates200ResponseAllOfResultsInner { +export interface GetLastStocksQuote200ResponseResults { /** - * The close price for the symbol in the given time period. + * The ask price. * @type {number} - * @memberof GetStocksAggregates200ResponseAllOfResultsInner + * @memberof GetLastStocksQuote200ResponseResults */ - 'c': number; + 'P'?: number; /** - * The highest price for the symbol in the given time period. + * The total number of shares available for sale at the current ask price. * @type {number} - * @memberof GetStocksAggregates200ResponseAllOfResultsInner + * @memberof GetLastStocksQuote200ResponseResults */ - 'h': number; + 'S'?: number; /** - * The lowest price for the symbol in the given time period. + * The exchange symbol that this item is traded under. + * @type {string} + * @memberof GetLastStocksQuote200ResponseResults + */ + 'T': string; + /** + * The exchange ID. See Exchanges for Massive.com\'s mapping of exchange IDs. * @type {number} - * @memberof GetStocksAggregates200ResponseAllOfResultsInner + * @memberof GetLastStocksQuote200ResponseResults */ - 'l': number; + 'X'?: number; /** - * The number of transactions in the aggregate window. + * A list of condition codes. + * @type {Array} + * @memberof GetLastStocksQuote200ResponseResults + */ + 'c'?: Array; + /** + * The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message. * @type {number} - * @memberof GetStocksAggregates200ResponseAllOfResultsInner + * @memberof GetLastStocksQuote200ResponseResults */ - 'n'?: number; + 'f'?: number; /** - * The open price for the symbol in the given time period. + * A list of indicator codes. + * @type {Array} + * @memberof GetLastStocksQuote200ResponseResults + */ + 'i'?: Array; + /** + * The bid price. * @type {number} - * @memberof GetStocksAggregates200ResponseAllOfResultsInner + * @memberof GetLastStocksQuote200ResponseResults */ - 'o': number; + 'p'?: number; /** - * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. - * @type {boolean} - * @memberof GetStocksAggregates200ResponseAllOfResultsInner + * The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). + * @type {number} + * @memberof GetLastStocksQuote200ResponseResults */ - 'otc'?: boolean; + 'q': number; /** - * The Unix millisecond timestamp for the start of the aggregate window. + * The total number of shares that buyers want to purchase at the current bid price. * @type {number} - * @memberof GetStocksAggregates200ResponseAllOfResultsInner + * @memberof GetLastStocksQuote200ResponseResults + */ + 's'?: number; + /** + * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. + * @type {number} + * @memberof GetLastStocksQuote200ResponseResults */ 't': number; /** - * The trading volume of the symbol in the given time period. + * The exchange ID. See Exchanges for Massive.com\'s mapping of exchange IDs. * @type {number} - * @memberof GetStocksAggregates200ResponseAllOfResultsInner + * @memberof GetLastStocksQuote200ResponseResults */ - 'v': number; + 'x'?: number; /** - * The volume weighted average price. + * The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange. * @type {number} - * @memberof GetStocksAggregates200ResponseAllOfResultsInner + * @memberof GetLastStocksQuote200ResponseResults */ - 'vw'?: number; + 'y': number; + /** + * There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C. * Tape A is NYSE listed securities * Tape B is NYSE ARCA / NYSE American * Tape C is NASDAQ + * @type {number} + * @memberof GetLastStocksQuote200ResponseResults + */ + 'z'?: number; } /** * * @export - * @interface GetStocksQuotes200Response + * @interface GetMarketHolidays200ResponseInner */ -export interface GetStocksQuotes200Response { +export interface GetMarketHolidays200ResponseInner { /** - * If present, this value can be used to fetch the next page of data. + * The market close time on the holiday (if it\'s not closed). * @type {string} - * @memberof GetStocksQuotes200Response + * @memberof GetMarketHolidays200ResponseInner */ - 'next_url'?: string; + 'close'?: string; /** - * A request id assigned by the server. + * The date of the holiday. * @type {string} - * @memberof GetStocksQuotes200Response + * @memberof GetMarketHolidays200ResponseInner */ - 'request_id'?: string; + 'date'?: string; /** - * An array of results containing the requested data. - * @type {Array} - * @memberof GetStocksQuotes200Response + * Which market the record is for. + * @type {string} + * @memberof GetMarketHolidays200ResponseInner */ - 'results'?: Array; + 'exchange'?: string; /** - * The status of this request\'s response. + * The name of the holiday. * @type {string} - * @memberof GetStocksQuotes200Response + * @memberof GetMarketHolidays200ResponseInner */ - 'status': string; + 'name'?: string; + /** + * The market open time on the holiday (if it\'s not closed). + * @type {string} + * @memberof GetMarketHolidays200ResponseInner + */ + 'open'?: string; + /** + * The status of the market on the holiday. + * @type {string} + * @memberof GetMarketHolidays200ResponseInner + */ + 'status'?: string; } /** * * @export - * @interface GetStocksQuotes200ResponseResultsInner + * @interface GetMarketStatus200Response */ -export interface GetStocksQuotes200ResponseResultsInner { +export interface GetMarketStatus200Response { /** - * The ask exchange ID - * @type {number} - * @memberof GetStocksQuotes200ResponseResultsInner - */ - 'ask_exchange'?: number; - /** - * The ask price. - * @type {number} - * @memberof GetStocksQuotes200ResponseResultsInner - */ - 'ask_price'?: number; - /** - * The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price. - * @type {number} - * @memberof GetStocksQuotes200ResponseResultsInner - */ - 'ask_size'?: number; - /** - * The bid exchange ID - * @type {number} - * @memberof GetStocksQuotes200ResponseResultsInner - */ - 'bid_exchange'?: number; - /** - * The bid price. - * @type {number} - * @memberof GetStocksQuotes200ResponseResultsInner - */ - 'bid_price'?: number; - /** - * The bid size. This represents the number of round lot orders at the given bid price. The normal round lot size is 100 shares. A bid size of 2 means there are 200 shares for purchase at the given bid price. - * @type {number} - * @memberof GetStocksQuotes200ResponseResultsInner - */ - 'bid_size'?: number; - /** - * A list of condition codes. - * @type {Array} - * @memberof GetStocksQuotes200ResponseResultsInner + * Whether or not the market is in post-market hours. + * @type {boolean} + * @memberof GetMarketStatus200Response */ - 'conditions'?: Array; + 'afterHours'?: boolean; /** - * A list of indicator codes. - * @type {Array} - * @memberof GetStocksQuotes200ResponseResultsInner + * + * @type {GetMarketStatus200ResponseCurrencies} + * @memberof GetMarketStatus200Response */ - 'indicators'?: Array; + 'currencies'?: GetMarketStatus200ResponseCurrencies; /** - * The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange. - * @type {number} - * @memberof GetStocksQuotes200ResponseResultsInner + * Whether or not the market is in pre-market hours. + * @type {boolean} + * @memberof GetMarketStatus200Response */ - 'participant_timestamp': number; + 'earlyHours'?: boolean; /** - * The sequence number represents the sequence in which quote events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). Values reset after each trading session/day. - * @type {number} - * @memberof GetStocksQuotes200ResponseResultsInner + * + * @type {GetMarketStatus200ResponseExchanges} + * @memberof GetMarketStatus200Response */ - 'sequence_number': number; + 'exchanges'?: GetMarketStatus200ResponseExchanges; /** - * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it. - * @type {number} - * @memberof GetStocksQuotes200ResponseResultsInner + * + * @type {GetMarketStatus200ResponseIndicesGroups} + * @memberof GetMarketStatus200Response */ - 'sip_timestamp': number; + 'indicesGroups'?: GetMarketStatus200ResponseIndicesGroups; /** - * There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C. * Tape A is NYSE listed securities * Tape B is NYSE ARCA / NYSE American * Tape C is NASDAQ - * @type {number} - * @memberof GetStocksQuotes200ResponseResultsInner + * The status of the market as a whole. + * @type {string} + * @memberof GetMarketStatus200Response */ - 'tape'?: number; + 'market'?: string; /** - * The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this quote. - * @type {number} - * @memberof GetStocksQuotes200ResponseResultsInner + * The current time of the server, returned as a date-time in RFC3339 format. + * @type {string} + * @memberof GetMarketStatus200Response */ - 'trf_timestamp'?: number; + 'serverTime'?: string; } /** - * + * Contains the status of various currency markets. * @export - * @interface GetStocksSnapshotDirection200Response + * @interface GetMarketStatus200ResponseCurrencies */ -export interface GetStocksSnapshotDirection200Response { +export interface GetMarketStatus200ResponseCurrencies { /** - * The status of this request\'s response. + * The status of the crypto market. * @type {string} - * @memberof GetStocksSnapshotDirection200Response + * @memberof GetMarketStatus200ResponseCurrencies */ - 'status': string; + 'crypto'?: string; /** - * An array of snapshot data for the specified tickers. - * @type {Array} - * @memberof GetStocksSnapshotDirection200Response + * The status of the forex market. + * @type {string} + * @memberof GetMarketStatus200ResponseCurrencies */ - 'tickers'?: Array; + 'fx'?: string; } /** - * + * Contains the status of different US stock exchanges (e.g., Nasdaq, NYSE). * @export - * @interface GetStocksSnapshotTicker200Response + * @interface GetMarketStatus200ResponseExchanges */ -export interface GetStocksSnapshotTicker200Response { +export interface GetMarketStatus200ResponseExchanges { /** - * The status of this request\'s response. + * The status of the Nasdaq market. * @type {string} - * @memberof GetStocksSnapshotTicker200Response + * @memberof GetMarketStatus200ResponseExchanges */ - 'status': string; + 'nasdaq'?: string; /** - * A request id assigned by the server. + * The status of the NYSE market. * @type {string} - * @memberof GetStocksSnapshotTicker200Response + * @memberof GetMarketStatus200ResponseExchanges */ - 'request_id': string; + 'nyse'?: string; /** - * - * @type {GetStocksSnapshotTicker200ResponseAllOfTicker} - * @memberof GetStocksSnapshotTicker200Response + * The status of the OTC market. + * @type {string} + * @memberof GetMarketStatus200ResponseExchanges */ - 'ticker'?: GetStocksSnapshotTicker200ResponseAllOfTicker; + 'otc'?: string; } /** - * Contains the requested snapshot data for the specified ticker. + * Contains the status of various index groups (e.g., MSCI, FTSE Russell). * @export - * @interface GetStocksSnapshotTicker200ResponseAllOfTicker + * @interface GetMarketStatus200ResponseIndicesGroups */ -export interface GetStocksSnapshotTicker200ResponseAllOfTicker { +export interface GetMarketStatus200ResponseIndicesGroups { /** - * - * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay} - * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker + * The status of Cboe Streaming Market Indices Cryptocurrency (\"CCCY\") indices trading hours. + * @type {string} + * @memberof GetMarketStatus200ResponseIndicesGroups */ - 'day'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay; + 'cccy'?: string; /** - * Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us. - * @type {number} - * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker + * The status of Cboe Global Indices (\"CGI\") trading hours. + * @type {string} + * @memberof GetMarketStatus200ResponseIndicesGroups */ - 'fmv'?: number; + 'cgi'?: string; /** - * - * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote} - * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker + * The status of Dow Jones indices trading hours + * @type {string} + * @memberof GetMarketStatus200ResponseIndicesGroups */ - 'lastQuote'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote; + 'dow_jones'?: string; /** - * - * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade} - * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker + * The status of Financial Times Stock Exchange Group (\"FTSE\") Russell indices trading hours. + * @type {string} + * @memberof GetMarketStatus200ResponseIndicesGroups */ - 'lastTrade'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade; + 'ftse_russell'?: string; /** - * - * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin} - * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker + * The status of Morgan Stanley Capital International (\"MSCI\") indices trading hours. + * @type {string} + * @memberof GetMarketStatus200ResponseIndicesGroups */ - 'min'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin; + 'msci'?: string; /** - * - * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay} - * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker + * The status of Morningstar (\"MSTAR\") indices trading hours. + * @type {string} + * @memberof GetMarketStatus200ResponseIndicesGroups */ - 'prevDay'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay; + 'mstar'?: string; /** - * The exchange symbol that this item is traded under. + * The status of Morningstar Customer (\"MSTARC\") indices trading hours. * @type {string} - * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker + * @memberof GetMarketStatus200ResponseIndicesGroups */ - 'ticker'?: string; + 'mstarc'?: string; /** - * The value of the change from the previous day. - * @type {number} - * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker + * The status of National Association of Securities Dealers Automated Quotations (\"Nasdaq\") indices trading hours. + * @type {string} + * @memberof GetMarketStatus200ResponseIndicesGroups */ - 'todaysChange'?: number; + 'nasdaq'?: string; /** - * The percentage change since the previous day. - * @type {number} - * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker + * The status of Standard & Poor\'s (\"S&P\") indices trading hours. + * @type {string} + * @memberof GetMarketStatus200ResponseIndicesGroups */ - 'todaysChangePerc'?: number; + 's_and_p'?: string; /** - * The last updated timestamp. - * @type {number} - * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker + * The status of Societe Generale indices trading hours. + * @type {string} + * @memberof GetMarketStatus200ResponseIndicesGroups */ - 'updated'?: number; + 'societe_generale'?: string; } /** * * @export - * @interface GetStocksSnapshotTickers200Response + * @interface GetOptionContract200Response */ -export interface GetStocksSnapshotTickers200Response { +export interface GetOptionContract200Response { /** - * The total number of results for this request. - * @type {number} - * @memberof GetStocksSnapshotTickers200Response + * If present, this value can be used to fetch the next page of data. + * @type {string} + * @memberof GetOptionContract200Response */ - 'count'?: number; + 'next_url'?: string; /** - * The status of this request\'s response. + * A request id assigned by the server. * @type {string} - * @memberof GetStocksSnapshotTickers200Response + * @memberof GetOptionContract200Response */ - 'status': string; + 'request_id': string; /** - * An array of snapshot data for the specified tickers. - * @type {Array} - * @memberof GetStocksSnapshotTickers200Response + * + * @type {GetOptionsChain200ResponseResultsInner} + * @memberof GetOptionContract200Response */ - 'tickers'?: Array; + 'results'?: GetOptionsChain200ResponseResultsInner; + /** + * The status of this request\'s response. + * @type {string} + * @memberof GetOptionContract200Response + */ + 'status': string; } /** * * @export - * @interface GetStocksSnapshotTickers200ResponseAllOfTickersInner + * @interface GetOptionsChain200Response */ -export interface GetStocksSnapshotTickers200ResponseAllOfTickersInner { +export interface GetOptionsChain200Response { /** - * - * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner + * If present, this value can be used to fetch the next page of data. + * @type {string} + * @memberof GetOptionsChain200Response */ - 'day'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay; + 'next_url'?: string; /** - * Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us. - * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner + * A request id assigned by the server. + * @type {string} + * @memberof GetOptionsChain200Response */ - 'fmv'?: number; + 'request_id': string; /** - * - * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner + * An array of results containing the requested data. + * @type {Array} + * @memberof GetOptionsChain200Response */ - 'lastQuote'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote; + 'results'?: Array; /** - * - * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner + * The status of this request\'s response. + * @type {string} + * @memberof GetOptionsChain200Response */ - 'lastTrade'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade; + 'status': string; +} +/** + * Contains the requested snapshot data for the specified contract. + * @export + * @interface GetOptionsChain200ResponseResultsInner + */ +export interface GetOptionsChain200ResponseResultsInner { /** - * - * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner + * The price of the underlying asset for the contract to break even. For a call, this value is (strike price + premium paid). For a put, this value is (strike price - premium paid). + * @type {number} + * @memberof GetOptionsChain200ResponseResultsInner */ - 'min'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin; + 'break_even_price': number; /** * - * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner - */ - 'prevDay'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay; - /** - * The exchange symbol that this item is traded under. - * @type {string} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner - */ - 'ticker'?: string; - /** - * The value of the change from the previous day. - * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner + * @type {GetOptionsChain200ResponseResultsInnerDay} + * @memberof GetOptionsChain200ResponseResultsInner */ - 'todaysChange'?: number; + 'day': GetOptionsChain200ResponseResultsInnerDay; /** - * The percentage change since the previous day. - * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner + * + * @type {GetOptionsChain200ResponseResultsInnerDetails} + * @memberof GetOptionsChain200ResponseResultsInner */ - 'todaysChangePerc'?: number; + 'details': GetOptionsChain200ResponseResultsInnerDetails; /** - * The last updated timestamp. + * Fair Market Value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us. * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner + * @memberof GetOptionsChain200ResponseResultsInner */ - 'updated'?: number; -} -/** - * The most recent daily bar for this ticker. - * @export - * @interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay - */ -export interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay { + 'fmv'?: number; /** - * The close price for the symbol in the given time period. + * If Fair Market Value (FMV) is available, this field is the nanosecond timestamp of the last FMV calculation. * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay + * @memberof GetOptionsChain200ResponseResultsInner */ - 'c': number; + 'fmv_last_updated'?: number; /** - * The highest price for the symbol in the given time period. - * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay + * + * @type {GetSnapshots200ResponseResultsInnerGreeks} + * @memberof GetOptionsChain200ResponseResultsInner */ - 'h': number; + 'greeks'?: GetSnapshots200ResponseResultsInnerGreeks; /** - * The lowest price for the symbol in the given time period. + * The market\'s forecast for the volatility of the underlying asset, based on this option\'s current price. * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay + * @memberof GetOptionsChain200ResponseResultsInner */ - 'l': number; + 'implied_volatility'?: number; /** - * The open price for the symbol in the given time period. - * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay + * + * @type {GetOptionsChain200ResponseResultsInnerLastQuote} + * @memberof GetOptionsChain200ResponseResultsInner */ - 'o': number; + 'last_quote': GetOptionsChain200ResponseResultsInnerLastQuote; /** - * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. - * @type {boolean} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay + * + * @type {GetOptionsChain200ResponseResultsInnerLastTrade} + * @memberof GetOptionsChain200ResponseResultsInner */ - 'otc'?: boolean; + 'last_trade'?: GetOptionsChain200ResponseResultsInnerLastTrade; /** - * The trading volume of the symbol in the given time period. + * The quantity of this contract held at the end of the last trading day. * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay + * @memberof GetOptionsChain200ResponseResultsInner */ - 'v': number; + 'open_interest': number; /** - * The volume weighted average price. - * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay + * + * @type {GetSnapshots200ResponseResultsInnerUnderlyingAsset} + * @memberof GetOptionsChain200ResponseResultsInner */ - 'vw': number; + 'underlying_asset': GetSnapshots200ResponseResultsInnerUnderlyingAsset; } /** - * The most recent quote for this ticker. This is only returned if your current plan includes quotes. + * The most recent daily bar for this contract. * @export - * @interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote + * @interface GetOptionsChain200ResponseResultsInnerDay */ -export interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote { +export interface GetOptionsChain200ResponseResultsInnerDay { /** - * The ask price. + * The value of the price change for the contract from the previous trading day. * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote + * @memberof GetOptionsChain200ResponseResultsInnerDay */ - 'P': number; + 'change': number; /** - * The ask size in lots. + * The percent of the price change for the contract from the previous trading day. * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote + * @memberof GetOptionsChain200ResponseResultsInnerDay */ - 'S': number; + 'change_percent': number; /** - * The bid price. + * The closing price for the contract of the day. * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote + * @memberof GetOptionsChain200ResponseResultsInnerDay */ - 'p': number; + 'close': number; /** - * The bid size in lots. + * The highest price for the contract of the day. * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote + * @memberof GetOptionsChain200ResponseResultsInnerDay */ - 's': number; + 'high': number; /** - * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. + * The nanosecond timestamp of when this information was updated. * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote - */ - 't': number; -} -/** - * The most recent trade for this ticker. This is only returned if your current plan includes trades. - * @export - * @interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade - */ -export interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade { - /** - * The trade conditions. - * @type {Array} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade + * @memberof GetOptionsChain200ResponseResultsInnerDay */ - 'c': Array; + 'last_updated'?: number; /** - * The Trade ID which uniquely identifies a trade. These are unique per combination of ticker, exchange, and TRF. For example: A trade for AAPL executed on NYSE and a trade for AAPL executed on NASDAQ could potentially have the same Trade ID. - * @type {string} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade + * The lowest price for the contract of the day. + * @type {number} + * @memberof GetOptionsChain200ResponseResultsInnerDay */ - 'i': string; + 'low': number; /** - * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. + * The open price for the contract of the day. * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade + * @memberof GetOptionsChain200ResponseResultsInnerDay */ - 'p': number; + 'open': number; /** - * The size (volume) of the trade. + * The closing price for the contract of previous trading day. * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade + * @memberof GetOptionsChain200ResponseResultsInnerDay */ - 's': number; + 'previous_close': number; /** - * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. + * The trading volume for the contract of the day. * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade + * @memberof GetOptionsChain200ResponseResultsInnerDay */ - 't': number; + 'volume': number; /** - * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. + * The trading volume weighted average price for the contract of the day. * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade + * @memberof GetOptionsChain200ResponseResultsInnerDay */ - 'x': number; + 'vwap': number; } /** - * The most recent minute bar for this ticker. + * The details for this contract. * @export - * @interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin + * @interface GetOptionsChain200ResponseResultsInnerDetails */ -export interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin { +export interface GetOptionsChain200ResponseResultsInnerDetails { /** - * The accumulated volume. - * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin + * The type of contract. Can be \"put\", \"call\", or in some rare cases, \"other\". + * @type {string} + * @memberof GetOptionsChain200ResponseResultsInnerDetails */ - 'av': number; + 'contract_type': GetOptionsChain200ResponseResultsInnerDetailsContractTypeEnum; /** - * The close price for the symbol in the given time period. - * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin + * The exercise style of this contract. See this link for more details on exercise styles. + * @type {string} + * @memberof GetOptionsChain200ResponseResultsInnerDetails */ - 'c': number; + 'exercise_style': GetOptionsChain200ResponseResultsInnerDetailsExerciseStyleEnum; /** - * The highest price for the symbol in the given time period. - * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin + * The contract\'s expiration date in YYYY-MM-DD format. + * @type {string} + * @memberof GetOptionsChain200ResponseResultsInnerDetails */ - 'h': number; + 'expiration_date': string; /** - * The lowest price for the symbol in the given time period. + * The number of shares per contract for this contract. * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin + * @memberof GetOptionsChain200ResponseResultsInnerDetails */ - 'l': number; + 'shares_per_contract': number; /** - * The number of transactions in the aggregate window. + * The strike price of the option contract. * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin + * @memberof GetOptionsChain200ResponseResultsInnerDetails */ - 'n': number; + 'strike_price': number; /** - * The open price for the symbol in the given time period. - * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin - */ - 'o': number; - /** - * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. - * @type {boolean} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin - */ - 'otc'?: boolean; - /** - * The Unix millisecond timestamp for the start of the aggregate window. - * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin - */ - 't': number; - /** - * The trading volume of the symbol in the given time period. - * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin - */ - 'v': number; - /** - * The volume weighted average price. - * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin + * The ticker symbol for the asset. + * @type {string} + * @memberof GetOptionsChain200ResponseResultsInnerDetails */ - 'vw': number; + 'ticker': string; } + /** - * The previous day\'s bar for this ticker. + * @export + * @enum {string} + */ +export enum GetOptionsChain200ResponseResultsInnerDetailsContractTypeEnum { + Put = 'put', + Call = 'call', + Other = 'other' +} +/** + * @export + * @enum {string} + */ +export enum GetOptionsChain200ResponseResultsInnerDetailsExerciseStyleEnum { + American = 'american', + European = 'european', + Bermudan = 'bermudan' +} + +/** + * The most recent quote for this contract. This is only returned if your current plan includes quotes. * @export - * @interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay + * @interface GetOptionsChain200ResponseResultsInnerLastQuote */ -export interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay { +export interface GetOptionsChain200ResponseResultsInnerLastQuote { /** - * The close price for the symbol in the given time period. + * The ask price. * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay + * @memberof GetOptionsChain200ResponseResultsInnerLastQuote */ - 'c': number; + 'ask': number; /** - * The highest price for the symbol in the given time period. + * The ask side exchange ID. See Exchanges for Massive.com\'s mapping of exchange IDs. * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay + * @memberof GetOptionsChain200ResponseResultsInnerLastQuote */ - 'h': number; + 'ask_exchange'?: number; /** - * The lowest price for the symbol in the given time period. + * The ask size. * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay + * @memberof GetOptionsChain200ResponseResultsInnerLastQuote */ - 'l': number; + 'ask_size': number; /** - * The open price for the symbol in the given time period. + * The bid price. * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay - */ - 'o': number; - /** - * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. - * @type {boolean} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay + * @memberof GetOptionsChain200ResponseResultsInnerLastQuote */ - 'otc'?: boolean; + 'bid': number; /** - * The trading volume of the symbol in the given time period. + * The bid side exchange ID. See Exchanges for Massive.com\'s mapping of exchange IDs. * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay + * @memberof GetOptionsChain200ResponseResultsInnerLastQuote */ - 'v': number; + 'bid_exchange'?: number; /** - * The volume weighted average price. + * The bid size. * @type {number} - * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay - */ - 'vw': number; -} -/** - * - * @export - * @interface GetStocksTrades200Response - */ -export interface GetStocksTrades200Response { - /** - * If present, this value can be used to fetch the next page of data. - * @type {string} - * @memberof GetStocksTrades200Response + * @memberof GetOptionsChain200ResponseResultsInnerLastQuote */ - 'next_url'?: string; + 'bid_size': number; /** - * A request id assigned by the server. - * @type {string} - * @memberof GetStocksTrades200Response + * The nanosecond timestamp of when this information was updated. + * @type {number} + * @memberof GetOptionsChain200ResponseResultsInnerLastQuote */ - 'request_id'?: string; + 'last_updated'?: number; /** - * An array of results containing the requested data. - * @type {Array} - * @memberof GetStocksTrades200Response + * The average of the bid and ask price. + * @type {number} + * @memberof GetOptionsChain200ResponseResultsInnerLastQuote */ - 'results'?: Array; + 'midpoint': number; /** - * The status of this request\'s response. + * The time relevance of the data. * @type {string} - * @memberof GetStocksTrades200Response + * @memberof GetOptionsChain200ResponseResultsInnerLastQuote */ - 'status': string; + 'timeframe'?: GetOptionsChain200ResponseResultsInnerLastQuoteTimeframeEnum; } + /** - * + * @export + * @enum {string} + */ +export enum GetOptionsChain200ResponseResultsInnerLastQuoteTimeframeEnum { + Delayed = 'DELAYED', + RealTime = 'REAL-TIME' +} + +/** + * The most recent trade for this contract. This is only returned if your current plan includes trades. * @export - * @interface GetStocksTrades200ResponseResultsInner + * @interface GetOptionsChain200ResponseResultsInnerLastTrade */ -export interface GetStocksTrades200ResponseResultsInner { +export interface GetOptionsChain200ResponseResultsInnerLastTrade { /** * A list of condition codes. * @type {Array} - * @memberof GetStocksTrades200ResponseResultsInner + * @memberof GetOptionsChain200ResponseResultsInnerLastTrade */ 'conditions'?: Array; /** - * The trade correction indicator. - * @type {number} - * @memberof GetStocksTrades200ResponseResultsInner - */ - 'correction'?: number; - /** - * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. + * The exchange ID. See Exchanges for Massive.com\'s mapping of exchange IDs. * @type {number} - * @memberof GetStocksTrades200ResponseResultsInner + * @memberof GetOptionsChain200ResponseResultsInnerLastTrade */ 'exchange': number; - /** - * The Trade ID which uniquely identifies a trade. These are unique per combination of ticker, exchange, and TRF. For example: A trade for AAPL executed on NYSE and a trade for AAPL executed on NASDAQ could potentially have the same Trade ID. - * @type {string} - * @memberof GetStocksTrades200ResponseResultsInner - */ - 'id': string; - /** - * The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the trade was actually generated at the exchange. - * @type {number} - * @memberof GetStocksTrades200ResponseResultsInner - */ - 'participant_timestamp': number; /** * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. * @type {number} - * @memberof GetStocksTrades200ResponseResultsInner + * @memberof GetOptionsChain200ResponseResultsInnerLastTrade */ 'price': number; - /** - * The sequence number represents the sequence in which trade events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). Values reset after each trading session/day. - * @type {number} - * @memberof GetStocksTrades200ResponseResultsInner - */ - 'sequence_number': number; /** * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this trade from the exchange which produced it. * @type {number} - * @memberof GetStocksTrades200ResponseResultsInner + * @memberof GetOptionsChain200ResponseResultsInnerLastTrade */ 'sip_timestamp': number; /** * The size of a trade (also known as volume). * @type {number} - * @memberof GetStocksTrades200ResponseResultsInner + * @memberof GetOptionsChain200ResponseResultsInnerLastTrade */ 'size': number; /** - * There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C. * Tape A is NYSE listed securities * Tape B is NYSE ARCA / NYSE American * Tape C is NASDAQ - * @type {number} - * @memberof GetStocksTrades200ResponseResultsInner - */ - 'tape'?: number; - /** - * The ID for the Trade Reporting Facility where the trade took place. - * @type {number} - * @memberof GetStocksTrades200ResponseResultsInner - */ - 'trf_id'?: number; - /** - * The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this trade. - * @type {number} - * @memberof GetStocksTrades200ResponseResultsInner + * The time relevance of the data. + * @type {string} + * @memberof GetOptionsChain200ResponseResultsInnerLastTrade */ - 'trf_timestamp'?: number; + 'timeframe'?: GetOptionsChain200ResponseResultsInnerLastTradeTimeframeEnum; +} + +/** + * @export + * @enum {string} + */ +export enum GetOptionsChain200ResponseResultsInnerLastTradeTimeframeEnum { + Delayed = 'DELAYED', + RealTime = 'REAL-TIME' } + /** * * @export - * @interface GetStocksV1ShortInterest200Response + * @interface GetOptionsContract200Response */ -export interface GetStocksV1ShortInterest200Response { - /** - * If present, this value can be used to fetch the next page. - * @type {string} - * @memberof GetStocksV1ShortInterest200Response - */ - 'next_url'?: string; +export interface GetOptionsContract200Response { /** * A request id assigned by the server. * @type {string} - * @memberof GetStocksV1ShortInterest200Response + * @memberof GetOptionsContract200Response */ - 'request_id': string; + 'request_id'?: string; /** - * The results for this request. - * @type {Array} - * @memberof GetStocksV1ShortInterest200Response + * + * @type {ListOptionsContracts200ResponseResultsInner} + * @memberof GetOptionsContract200Response */ - 'results': Array; + 'results'?: ListOptionsContracts200ResponseResultsInner; /** * The status of this request\'s response. * @type {string} - * @memberof GetStocksV1ShortInterest200Response + * @memberof GetOptionsContract200Response */ - 'status': GetStocksV1ShortInterest200ResponseStatusEnum; -} - -/** - * @export - * @enum {string} - */ -export enum GetStocksV1ShortInterest200ResponseStatusEnum { - Ok = 'OK' + 'status'?: string; } - /** * * @export - * @interface GetStocksV1ShortInterest200ResponseResultsInner + * @interface GetOptionsOpenClose200Response */ -export interface GetStocksV1ShortInterest200ResponseResultsInner { +export interface GetOptionsOpenClose200Response { /** - * The average daily trading volume for the stock over a specified period, typically used to contextualize short interest. + * The close price of the ticker symbol in after hours trading. * @type {number} - * @memberof GetStocksV1ShortInterest200ResponseResultsInner + * @memberof GetOptionsOpenClose200Response */ - 'avg_daily_volume': number; + 'afterHours'?: number; /** - * Calculated as short_interest divided by avg_daily_volume, representing the estimated number of days it would take to cover all short positions based on average trading volume. + * The close price for the symbol in the given time period. * @type {number} - * @memberof GetStocksV1ShortInterest200ResponseResultsInner + * @memberof GetOptionsOpenClose200Response */ - 'days_to_cover': number; + 'close': number; /** - * The date (formatted as YYYY-MM-DD) on which the short interest data is considered settled, typically based on exchange reporting schedules. + * The requested date. * @type {string} - * @memberof GetStocksV1ShortInterest200ResponseResultsInner + * @memberof GetOptionsOpenClose200Response */ - 'settlement_date': string; + 'from': string; /** - * The total number of shares that have been sold short but have not yet been covered or closed out. + * The highest price for the symbol in the given time period. * @type {number} - * @memberof GetStocksV1ShortInterest200ResponseResultsInner + * @memberof GetOptionsOpenClose200Response */ - 'short_interest'?: number; + 'high': number; /** - * The primary ticker symbol for the stock. + * The lowest price for the symbol in the given time period. + * @type {number} + * @memberof GetOptionsOpenClose200Response + */ + 'low': number; + /** + * The open price for the symbol in the given time period. + * @type {number} + * @memberof GetOptionsOpenClose200Response + */ + 'open': number; + /** + * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. + * @type {boolean} + * @memberof GetOptionsOpenClose200Response + */ + 'otc'?: boolean; + /** + * The open price of the ticker symbol in pre-market trading. + * @type {number} + * @memberof GetOptionsOpenClose200Response + */ + 'preMarket'?: number; + /** + * The status of this request\'s response. * @type {string} - * @memberof GetStocksV1ShortInterest200ResponseResultsInner + * @memberof GetOptionsOpenClose200Response */ - 'ticker'?: string; + 'status': string; + /** + * The exchange symbol that this item is traded under. + * @type {string} + * @memberof GetOptionsOpenClose200Response + */ + 'symbol': string; + /** + * The trading volume of the symbol in the given time period. + * @type {number} + * @memberof GetOptionsOpenClose200Response + */ + 'volume': number; } /** * * @export - * @interface GetStocksV1ShortVolume200Response + * @interface GetOptionsQuotes200Response */ -export interface GetStocksV1ShortVolume200Response { +export interface GetOptionsQuotes200Response { /** - * If present, this value can be used to fetch the next page. + * If present, this value can be used to fetch the next page of data. * @type {string} - * @memberof GetStocksV1ShortVolume200Response + * @memberof GetOptionsQuotes200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} - * @memberof GetStocksV1ShortVolume200Response + * @memberof GetOptionsQuotes200Response */ - 'request_id': string; + 'request_id'?: string; /** - * The results for this request. - * @type {Array} - * @memberof GetStocksV1ShortVolume200Response + * An array of results containing the requested data. + * @type {Array} + * @memberof GetOptionsQuotes200Response */ - 'results': Array; + 'results'?: Array; /** * The status of this request\'s response. * @type {string} - * @memberof GetStocksV1ShortVolume200Response + * @memberof GetOptionsQuotes200Response */ - 'status': GetStocksV1ShortVolume200ResponseStatusEnum; -} - -/** - * @export - * @enum {string} - */ -export enum GetStocksV1ShortVolume200ResponseStatusEnum { - Ok = 'OK' + 'status': string; } - /** * * @export - * @interface GetStocksV1ShortVolume200ResponseResultsInner + * @interface GetOptionsQuotes200ResponseResultsInner */ -export interface GetStocksV1ShortVolume200ResponseResultsInner { +export interface GetOptionsQuotes200ResponseResultsInner { /** - * Short volume reported via the Alternative Display Facility (ADF), excluding exempt volume. + * The ask exchange ID * @type {number} - * @memberof GetStocksV1ShortVolume200ResponseResultsInner + * @memberof GetOptionsQuotes200ResponseResultsInner */ - 'adf_short_volume'?: number; + 'ask_exchange'?: number; /** - * Short volume reported via ADF that was marked as exempt. + * The ask price. * @type {number} - * @memberof GetStocksV1ShortVolume200ResponseResultsInner + * @memberof GetOptionsQuotes200ResponseResultsInner */ - 'adf_short_volume_exempt'?: number; + 'ask_price'?: number; /** - * The date of trade activity reported in the format YYYY-MM-DD - * @type {string} - * @memberof GetStocksV1ShortVolume200ResponseResultsInner + * The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price. + * @type {number} + * @memberof GetOptionsQuotes200ResponseResultsInner */ - 'date': string; + 'ask_size'?: number; /** - * Portion of short volume that was marked as exempt from regulation SHO. + * The bid exchange ID * @type {number} - * @memberof GetStocksV1ShortVolume200ResponseResultsInner + * @memberof GetOptionsQuotes200ResponseResultsInner */ - 'exempt_volume'?: number; + 'bid_exchange'?: number; /** - * Short volume reported from Nasdaq\'s Carteret facility, excluding exempt volume. + * The bid price. * @type {number} - * @memberof GetStocksV1ShortVolume200ResponseResultsInner + * @memberof GetOptionsQuotes200ResponseResultsInner */ - 'nasdaq_carteret_short_volume'?: number; + 'bid_price'?: number; /** - * Short volume from Nasdaq Carteret that was marked as exempt. + * The bid size. This represents the number of round lot orders at the given bid price. The normal round lot size is 100 shares. A bid size of 2 means there are 200 shares for purchase at the given bid price. * @type {number} - * @memberof GetStocksV1ShortVolume200ResponseResultsInner + * @memberof GetOptionsQuotes200ResponseResultsInner */ - 'nasdaq_carteret_short_volume_exempt'?: number; + 'bid_size'?: number; /** - * Short volume reported from Nasdaq\'s Chicago facility, excluding exempt volume. + * The sequence number represents the sequence in which quote events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). * @type {number} - * @memberof GetStocksV1ShortVolume200ResponseResultsInner + * @memberof GetOptionsQuotes200ResponseResultsInner */ - 'nasdaq_chicago_short_volume'?: number; + 'sequence_number': number; /** - * Short volume from Nasdaq Chicago that was marked as exempt. + * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it. * @type {number} - * @memberof GetStocksV1ShortVolume200ResponseResultsInner + * @memberof GetOptionsQuotes200ResponseResultsInner */ - 'nasdaq_chicago_short_volume_exempt'?: number; + 'sip_timestamp': number; +} +/** + * + * @export + * @interface GetOptionsTrades200Response + */ +export interface GetOptionsTrades200Response { /** - * Portion of short volume that was not exempt from regulation SHO (i.e., short_volume - exempt_volume). - * @type {number} - * @memberof GetStocksV1ShortVolume200ResponseResultsInner + * If present, this value can be used to fetch the next page of data. + * @type {string} + * @memberof GetOptionsTrades200Response */ - 'non_exempt_volume'?: number; + 'next_url'?: string; /** - * Short volume reported from NYSE facilities, excluding exempt volume. + * A request id assigned by the server. + * @type {string} + * @memberof GetOptionsTrades200Response + */ + 'request_id'?: string; + /** + * An array of results containing the requested data. + * @type {Array} + * @memberof GetOptionsTrades200Response + */ + 'results'?: Array; + /** + * The status of this request\'s response. + * @type {string} + * @memberof GetOptionsTrades200Response + */ + 'status': string; +} +/** + * + * @export + * @interface GetOptionsTrades200ResponseResultsInner + */ +export interface GetOptionsTrades200ResponseResultsInner { + /** + * A list of condition codes. + * @type {Array} + * @memberof GetOptionsTrades200ResponseResultsInner + */ + 'conditions'?: Array; + /** + * The trade correction indicator. * @type {number} - * @memberof GetStocksV1ShortVolume200ResponseResultsInner + * @memberof GetOptionsTrades200ResponseResultsInner */ - 'nyse_short_volume'?: number; + 'correction'?: number; /** - * Short volume from NYSE facilities that was marked as exempt. + * The exchange ID. See Exchanges for Massive.com\'s mapping of exchange IDs. * @type {number} - * @memberof GetStocksV1ShortVolume200ResponseResultsInner + * @memberof GetOptionsTrades200ResponseResultsInner */ - 'nyse_short_volume_exempt'?: number; + 'exchange': number; /** - * Total number of shares sold short across all venues for the ticker on the given date. + * The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the trade was actually generated at the exchange. * @type {number} - * @memberof GetStocksV1ShortVolume200ResponseResultsInner + * @memberof GetOptionsTrades200ResponseResultsInner */ - 'short_volume'?: number; + 'participant_timestamp'?: number; /** - * The percentage of total volume that was sold short. Calculated as (short_volume / total_volume) * 100. + * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. * @type {number} - * @memberof GetStocksV1ShortVolume200ResponseResultsInner + * @memberof GetOptionsTrades200ResponseResultsInner */ - 'short_volume_ratio'?: number; + 'price': number; /** - * The primary ticker symbol for the stock. - * @type {string} - * @memberof GetStocksV1ShortVolume200ResponseResultsInner + * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this trade from the exchange which produced it. + * @type {number} + * @memberof GetOptionsTrades200ResponseResultsInner */ - 'ticker'?: string; + 'sip_timestamp': number; /** - * Total reported volume across all venues for the ticker on the given date. + * The size of a trade (also known as volume). * @type {number} - * @memberof GetStocksV1ShortVolume200ResponseResultsInner + * @memberof GetOptionsTrades200ResponseResultsInner */ - 'total_volume'?: number; + 'size': number; } /** * * @export - * @interface GetTicker200Response + * @interface GetOptionsV1Exchanges200Response */ -export interface GetTicker200Response { +export interface GetOptionsV1Exchanges200Response { /** - * The total number of results for this request. - * @type {number} - * @memberof GetTicker200Response + * If present, this value can be used to fetch the next page. + * @type {string} + * @memberof GetOptionsV1Exchanges200Response */ - 'count'?: number; + 'next_url'?: string; /** * A request id assigned by the server. * @type {string} - * @memberof GetTicker200Response + * @memberof GetOptionsV1Exchanges200Response */ - 'request_id'?: string; + 'request_id': string; /** - * - * @type {GetTicker200ResponseResults} - * @memberof GetTicker200Response + * The results for this request. + * @type {Array} + * @memberof GetOptionsV1Exchanges200Response */ - 'results'?: GetTicker200ResponseResults; + 'results': Array; /** * The status of this request\'s response. * @type {string} - * @memberof GetTicker200Response + * @memberof GetOptionsV1Exchanges200Response */ - 'status'?: string; + 'status': GetOptionsV1Exchanges200ResponseStatusEnum; } + /** - * Ticker with details. + * @export + * @enum {string} + */ +export enum GetOptionsV1Exchanges200ResponseStatusEnum { + Ok = 'OK' +} + +/** + * * @export - * @interface GetTicker200ResponseResults + * @interface GetOptionsV1Exchanges200ResponseResultsInner */ -export interface GetTicker200ResponseResults { +export interface GetOptionsV1Exchanges200ResponseResultsInner { /** - * Whether or not the asset is actively traded. False means the asset has been delisted. - * @type {boolean} - * @memberof GetTicker200ResponseResults + * Exchange acronym or short name (e.g., \'ISE\', \'GEMX\') - may be null for some venues. + * @type {string} + * @memberof GetOptionsV1Exchanges200ResponseResultsInner */ - 'active': boolean; + 'acronym'?: string; /** - * - * @type {GetTicker200ResponseResultsAddress} - * @memberof GetTicker200ResponseResults + * Numeric identifier for the options trading venue or exchange. + * @type {string} + * @memberof GetOptionsV1Exchanges200ResponseResultsInner */ - 'address'?: GetTicker200ResponseResultsAddress; + 'id': string; /** - * - * @type {GetTicker200ResponseResultsBranding} - * @memberof GetTicker200ResponseResults + * Geographic location code. + * @type {string} + * @memberof GetOptionsV1Exchanges200ResponseResultsInner */ - 'branding'?: GetTicker200ResponseResultsBranding; + 'locale'?: string; /** - * The CIK number for this ticker. Find more information [here](https://en.wikipedia.org/wiki/Central_Index_Key). + * Market Identifier Code (MIC) - ISO 10383 standard four-character code identifying the specific options market. * @type {string} - * @memberof GetTicker200ResponseResults + * @memberof GetOptionsV1Exchanges200ResponseResultsInner */ - 'cik'?: string; + 'mic'?: string; /** - * The composite OpenFIGI number for this ticker. Find more information [here](https://www.openfigi.com/about/figi) + * Full official name of the options exchange or trading venue. * @type {string} - * @memberof GetTicker200ResponseResults + * @memberof GetOptionsV1Exchanges200ResponseResultsInner */ - 'composite_figi'?: string; + 'name': string; /** - * The name of the currency that this asset is traded with. + * Operating Market Identifier Code - identifies the parent organization or operating entity. * @type {string} - * @memberof GetTicker200ResponseResults + * @memberof GetOptionsV1Exchanges200ResponseResultsInner */ - 'currency_name': string; + 'operating_mic'?: string; /** - * The last date that the asset was traded. + * Single-character participant identifier used in consolidator market data feeds and options trade reporting. * @type {string} - * @memberof GetTicker200ResponseResults + * @memberof GetOptionsV1Exchanges200ResponseResultsInner */ - 'delisted_utc'?: string; + 'participant_id'?: string; /** - * A description of the company and what they do/offer. + * Type of venue: \'exchange\' for options exchanges, \'SIP\' for Securities Information Processors like OPRA (Options Price Reporting Authority). * @type {string} - * @memberof GetTicker200ResponseResults + * @memberof GetOptionsV1Exchanges200ResponseResultsInner */ - 'description'?: string; + 'type': string; /** - * The URL of the company\'s website homepage. + * Official website URL of the organization operating the options exchange. * @type {string} - * @memberof GetTicker200ResponseResults + * @memberof GetOptionsV1Exchanges200ResponseResultsInner */ - 'homepage_url'?: string; + 'url'?: string; +} +/** + * + * @export + * @interface GetPreviousCryptoAggregates200Response + */ +export interface GetPreviousCryptoAggregates200Response { /** - * The date that the symbol was first publicly listed in the format YYYY-MM-DD. + * The exchange symbol that this item is traded under. * @type {string} - * @memberof GetTicker200ResponseResults + * @memberof GetPreviousCryptoAggregates200Response */ - 'list_date'?: string; + 'ticker': string; /** - * The locale of the asset. - * @type {string} - * @memberof GetTicker200ResponseResults + * Whether or not this response was adjusted for splits. + * @type {boolean} + * @memberof GetPreviousCryptoAggregates200Response */ - 'locale': GetTicker200ResponseResultsLocaleEnum; + 'adjusted': boolean; /** - * The market type of the asset. + * The number of aggregates (minute or day) used to generate the response. + * @type {number} + * @memberof GetPreviousCryptoAggregates200Response + */ + 'queryCount': number; + /** + * A request id assigned by the server. * @type {string} - * @memberof GetTicker200ResponseResults + * @memberof GetPreviousCryptoAggregates200Response */ - 'market': GetTicker200ResponseResultsMarketEnum; + 'request_id': string; /** - * The most recent close price of the ticker multiplied by weighted outstanding shares. + * The total number of results for this request. * @type {number} - * @memberof GetTicker200ResponseResults + * @memberof GetPreviousCryptoAggregates200Response */ - 'market_cap'?: number; + 'resultsCount': number; /** - * The name of the asset. For stocks/equities this will be the companies registered name. For crypto/fx this will be the name of the currency or coin pair. + * The status of this request\'s response. * @type {string} - * @memberof GetTicker200ResponseResults + * @memberof GetPreviousCryptoAggregates200Response */ - 'name': string; + 'status': string; /** - * The phone number for the company behind this ticker. - * @type {string} - * @memberof GetTicker200ResponseResults + * An array of results containing the requested data. + * @type {Array} + * @memberof GetPreviousCryptoAggregates200Response */ - 'phone_number'?: string; + 'results'?: Array; +} +/** + * + * @export + * @interface GetPreviousForexAggregates200Response + */ +export interface GetPreviousForexAggregates200Response { /** - * The Market Identifier Code (MIC) of the primary listing exchange for this asset (see [ISO 10383](https://www.iso20022.org/market-identifier-codes)). + * The exchange symbol that this item is traded under. * @type {string} - * @memberof GetTicker200ResponseResults + * @memberof GetPreviousForexAggregates200Response */ - 'primary_exchange'?: string; + 'ticker': string; /** - * Round lot size of this security. + * Whether or not this response was adjusted for splits. + * @type {boolean} + * @memberof GetPreviousForexAggregates200Response + */ + 'adjusted': boolean; + /** + * The number of aggregates (minute or day) used to generate the response. * @type {number} - * @memberof GetTicker200ResponseResults + * @memberof GetPreviousForexAggregates200Response */ - 'round_lot'?: number; + 'queryCount': number; /** - * The share Class OpenFIGI number for this ticker. Find more information [here](https://www.openfigi.com/about/figi) + * A request id assigned by the server. * @type {string} - * @memberof GetTicker200ResponseResults + * @memberof GetPreviousForexAggregates200Response */ - 'share_class_figi'?: string; + 'request_id': string; /** - * The recorded number of outstanding shares for this particular share class. + * The total number of results for this request. * @type {number} - * @memberof GetTicker200ResponseResults + * @memberof GetPreviousForexAggregates200Response */ - 'share_class_shares_outstanding'?: number; + 'resultsCount': number; /** - * The standard industrial classification code for this ticker. For a list of SIC Codes, see the SEC\'s SIC Code List. + * The status of this request\'s response. * @type {string} - * @memberof GetTicker200ResponseResults + * @memberof GetPreviousForexAggregates200Response */ - 'sic_code'?: string; + 'status': string; /** - * A description of this ticker\'s SIC code. - * @type {string} - * @memberof GetTicker200ResponseResults + * An array of results containing the requested data. + * @type {Array} + * @memberof GetPreviousForexAggregates200Response */ - 'sic_description'?: string; + 'results'?: Array; +} +/** + * + * @export + * @interface GetPreviousForexAggregates200ResponseAllOfResultsInner + */ +export interface GetPreviousForexAggregates200ResponseAllOfResultsInner { /** * The exchange symbol that this item is traded under. * @type {string} - * @memberof GetTicker200ResponseResults + * @memberof GetPreviousForexAggregates200ResponseAllOfResultsInner */ - 'ticker': string; + 'T': string; /** - * The root of a specified ticker. For example, the root of BRK.A is BRK. - * @type {string} - * @memberof GetTicker200ResponseResults + * The close price for the symbol in the given time period. + * @type {number} + * @memberof GetPreviousForexAggregates200ResponseAllOfResultsInner */ - 'ticker_root'?: string; + 'c': number; /** - * The suffix of a specified ticker. For example, the suffix of BRK.A is A. - * @type {string} - * @memberof GetTicker200ResponseResults + * The highest price for the symbol in the given time period. + * @type {number} + * @memberof GetPreviousForexAggregates200ResponseAllOfResultsInner */ - 'ticker_suffix'?: string; + 'h': number; /** - * The approximate number of employees for the company. + * The lowest price for the symbol in the given time period. * @type {number} - * @memberof GetTicker200ResponseResults + * @memberof GetPreviousForexAggregates200ResponseAllOfResultsInner */ - 'total_employees'?: number; + 'l': number; /** - * The type of the asset. Find the types that we support via our [Ticker Types API](https://polygon.io/docs/stocks/get_v3_reference_tickers_types). - * @type {string} - * @memberof GetTicker200ResponseResults + * The number of transactions in the aggregate window. + * @type {number} + * @memberof GetPreviousForexAggregates200ResponseAllOfResultsInner */ - 'type'?: string; + 'n'?: number; /** - * The shares outstanding calculated assuming all shares of other share classes are converted to this share class. + * The open price for the symbol in the given time period. * @type {number} - * @memberof GetTicker200ResponseResults + * @memberof GetPreviousForexAggregates200ResponseAllOfResultsInner */ - 'weighted_shares_outstanding'?: number; -} - -/** - * @export - * @enum {string} - */ -export enum GetTicker200ResponseResultsLocaleEnum { - Us = 'us', - Global = 'global' -} -/** - * @export - * @enum {string} - */ -export enum GetTicker200ResponseResultsMarketEnum { - Stocks = 'stocks', - Crypto = 'crypto', - Fx = 'fx', - Otc = 'otc', - Indices = 'indices' + 'o': number; + /** + * The Unix millisecond timestamp for the start of the aggregate window. + * @type {number} + * @memberof GetPreviousForexAggregates200ResponseAllOfResultsInner + */ + 't': number; + /** + * The trading volume of the symbol in the given time period. + * @type {number} + * @memberof GetPreviousForexAggregates200ResponseAllOfResultsInner + */ + 'v': number; + /** + * The volume weighted average price. + * @type {number} + * @memberof GetPreviousForexAggregates200ResponseAllOfResultsInner + */ + 'vw'?: number; } - /** - * Company headquarters address details. + * * @export - * @interface GetTicker200ResponseResultsAddress + * @interface GetPreviousIndicesAggregates200Response */ -export interface GetTicker200ResponseResultsAddress { +export interface GetPreviousIndicesAggregates200Response { /** - * The first line of the company\'s headquarters address. + * The exchange symbol that this item is traded under. * @type {string} - * @memberof GetTicker200ResponseResultsAddress + * @memberof GetPreviousIndicesAggregates200Response */ - 'address1'?: string; + 'ticker': string; /** - * The second line of the company\'s headquarters address, if applicable. - * @type {string} - * @memberof GetTicker200ResponseResultsAddress + * The number of aggregates (minute or day) used to generate the response. + * @type {number} + * @memberof GetPreviousIndicesAggregates200Response */ - 'address2'?: string; + 'queryCount': number; /** - * The city of the company\'s headquarters address. + * A request id assigned by the server. * @type {string} - * @memberof GetTicker200ResponseResultsAddress + * @memberof GetPreviousIndicesAggregates200Response */ - 'city'?: string; - /** - * The postal code of the company\'s headquarters address. - * @type {string} - * @memberof GetTicker200ResponseResultsAddress - */ - 'postal_code'?: string; + 'request_id': string; /** - * The state of the company\'s headquarters address. - * @type {string} - * @memberof GetTicker200ResponseResultsAddress + * The total number of results for this request. + * @type {number} + * @memberof GetPreviousIndicesAggregates200Response */ - 'state'?: string; -} -/** - * Provides URLs aiding in visual identification. - * @export - * @interface GetTicker200ResponseResultsBranding - */ -export interface GetTicker200ResponseResultsBranding { + 'resultsCount': number; /** - * A link to this ticker\'s company\'s icon. Icon\'s are generally smaller, square images that represent the company at a glance. Note that you must provide an API key when accessing this URL. See the \"Authentication\" section at the top of this page for more details. + * The status of this request\'s response. * @type {string} - * @memberof GetTicker200ResponseResultsBranding + * @memberof GetPreviousIndicesAggregates200Response */ - 'icon_url'?: string; + 'status': string; /** - * A link to this ticker\'s company\'s logo. Note that you must provide an API key when accessing this URL. See the \"Authentication\" section at the top of this page for more details. - * @type {string} - * @memberof GetTicker200ResponseResultsBranding + * An array of results containing the requested data. + * @type {Array} + * @memberof GetPreviousIndicesAggregates200Response */ - 'logo_url'?: string; + 'results'?: Array; } /** * * @export - * @interface GetTmxV1CorporateEvents200Response + * @interface GetPreviousIndicesAggregates200ResponseAllOfResultsInner */ -export interface GetTmxV1CorporateEvents200Response { +export interface GetPreviousIndicesAggregates200ResponseAllOfResultsInner { /** - * If present, this value can be used to fetch the next page. - * @type {string} - * @memberof GetTmxV1CorporateEvents200Response + * The close value for the symbol in the given time period. + * @type {number} + * @memberof GetPreviousIndicesAggregates200ResponseAllOfResultsInner */ - 'next_url'?: string; + 'c': number; /** - * A request id assigned by the server. - * @type {string} - * @memberof GetTmxV1CorporateEvents200Response + * The highest value for the symbol in the given time period. + * @type {number} + * @memberof GetPreviousIndicesAggregates200ResponseAllOfResultsInner */ - 'request_id': string; + 'h': number; /** - * The results for this request. - * @type {Array} - * @memberof GetTmxV1CorporateEvents200Response + * The lowest value for the symbol in the given time period. + * @type {number} + * @memberof GetPreviousIndicesAggregates200ResponseAllOfResultsInner */ - 'results': Array; + 'l': number; /** - * The status of this request\'s response. - * @type {string} - * @memberof GetTmxV1CorporateEvents200Response + * The open value for the symbol in the given time period. + * @type {number} + * @memberof GetPreviousIndicesAggregates200ResponseAllOfResultsInner */ - 'status': GetTmxV1CorporateEvents200ResponseStatusEnum; -} - -/** - * @export - * @enum {string} - */ -export enum GetTmxV1CorporateEvents200ResponseStatusEnum { - Ok = 'OK' + 'o': number; + /** + * The Unix millisecond timestamp for the start of the aggregate window. + * @type {number} + * @memberof GetPreviousIndicesAggregates200ResponseAllOfResultsInner + */ + 't': number; } - /** * * @export - * @interface GetTmxV1CorporateEvents200ResponseResultsInner + * @interface GetRelatedCompanies200Response */ -export interface GetTmxV1CorporateEvents200ResponseResultsInner { - /** - * Full name of the company. - * @type {string} - * @memberof GetTmxV1CorporateEvents200ResponseResultsInner - */ - 'company_name'?: string; - /** - * Scheduled date of the corporate event, formatted as YYYY-MM-DD. - * @type {string} - * @memberof GetTmxV1CorporateEvents200ResponseResultsInner - */ - 'date'?: string; +export interface GetRelatedCompanies200Response { /** - * Standard international identifier for the company\'s common stock. + * A request id assigned by the server. * @type {string} - * @memberof GetTmxV1CorporateEvents200ResponseResultsInner + * @memberof GetRelatedCompanies200Response */ - 'isin'?: string; + 'request_id'?: string; /** - * Name or title of the event. - * @type {string} - * @memberof GetTmxV1CorporateEvents200ResponseResultsInner + * An array of results containing the requested data. + * @type {Array} + * @memberof GetRelatedCompanies200Response */ - 'name'?: string; + 'results'?: Array; /** - * The current status of the event. Possible values include: approved, canceled, confirmed, historical, pending_approval, postponed, and unconfirmed. + * The status of this request\'s response. * @type {string} - * @memberof GetTmxV1CorporateEvents200ResponseResultsInner + * @memberof GetRelatedCompanies200Response */ 'status'?: string; /** - * The company\'s stock symbol. + * The ticker being queried. * @type {string} - * @memberof GetTmxV1CorporateEvents200ResponseResultsInner + * @memberof GetRelatedCompanies200Response */ 'ticker'?: string; +} +/** + * The tickers related to the requested ticker. + * @export + * @interface GetRelatedCompanies200ResponseResultsInner + */ +export interface GetRelatedCompanies200ResponseResultsInner { /** - * Unique numeric identifier for the company used by TMX. - * @type {number} - * @memberof GetTmxV1CorporateEvents200ResponseResultsInner - */ - 'tmx_company_id'?: number; - /** - * The unique alphanumeric identifier for the event record used by TMX. - * @type {string} - * @memberof GetTmxV1CorporateEvents200ResponseResultsInner - */ - 'tmx_record_id'?: string; - /** - * MIC (Market Identifier Code) of the exchange where the company\'s stock is listed. - * @type {string} - * @memberof GetTmxV1CorporateEvents200ResponseResultsInner - */ - 'trading_venue'?: string; - /** - * The normalized type of corporate event. Possible values include: analyst_day, business_update, capital_markets_day, conference, dividend, earnings_announcement_date, earnings_conference_call, earnings_results_announcement, forum, interim_statement, other_interim_announcement, production_update, research_and_development_day, seminar, shareholder_meeting, sales_update, stock_split, summit, service_level_update, tradeshow, company_travel, and workshop. - * @type {string} - * @memberof GetTmxV1CorporateEvents200ResponseResultsInner - */ - 'type'?: string; - /** - * URL linking to the primary public source of the event announcement, if available. + * A ticker related to the requested ticker. * @type {string} - * @memberof GetTmxV1CorporateEvents200ResponseResultsInner + * @memberof GetRelatedCompanies200ResponseResultsInner */ - 'url'?: string; + 'ticker': string; } /** * * @export - * @interface IndexAggsBase + * @interface GetSnapshotSummary200Response */ -export interface IndexAggsBase { - /** - * The number of aggregates (minute or day) used to generate the response. - * @type {number} - * @memberof IndexAggsBase - */ - 'queryCount': number; +export interface GetSnapshotSummary200Response { /** * A request id assigned by the server. * @type {string} - * @memberof IndexAggsBase + * @memberof GetSnapshotSummary200Response */ 'request_id': string; /** - * The total number of results for this request. - * @type {number} - * @memberof IndexAggsBase + * An array of results containing the requested data. + * @type {Array} + * @memberof GetSnapshotSummary200Response */ - 'resultsCount': number; + 'results'?: Array; /** * The status of this request\'s response. * @type {string} - * @memberof IndexAggsBase + * @memberof GetSnapshotSummary200Response */ 'status': string; } /** * * @export - * @interface IndicesGroupedResults + * @interface GetSnapshotSummary200ResponseResultsInner */ -export interface IndicesGroupedResults { +export interface GetSnapshotSummary200ResponseResultsInner { /** - * An array of results containing the requested data. - * @type {Array} - * @memberof IndicesGroupedResults + * + * @type {GetSnapshotSummary200ResponseResultsInnerBranding} + * @memberof GetSnapshotSummary200ResponseResultsInner */ - 'results'?: Array; -} -/** - * - * @export - * @interface IndicesOpenClose - */ -export interface IndicesOpenClose { + 'branding'?: GetSnapshotSummary200ResponseResultsInnerBranding; /** - * The close value of the ticker symbol in after hours trading. - * @type {number} - * @memberof IndicesOpenClose + * The error while looking for this ticker. + * @type {string} + * @memberof GetSnapshotSummary200ResponseResultsInner */ - 'afterHours'?: number; + 'error'?: string; /** - * The close value for the symbol in the given time period. + * The nanosecond timestamp of when this information was updated. * @type {number} - * @memberof IndicesOpenClose + * @memberof GetSnapshotSummary200ResponseResultsInner */ - 'close': number; + 'last_updated'?: number; /** - * The requested date. + * The market status for the market that trades this ticker. * @type {string} - * @memberof IndicesOpenClose + * @memberof GetSnapshotSummary200ResponseResultsInner */ - 'from': string; + 'market_status'?: string; /** - * The highest value for the symbol in the given time period. - * @type {number} - * @memberof IndicesOpenClose + * The error message while looking for this ticker. + * @type {string} + * @memberof GetSnapshotSummary200ResponseResultsInner */ - 'high': number; + 'message'?: string; /** - * The lowest value for the symbol in the given time period. - * @type {number} - * @memberof IndicesOpenClose + * Name of ticker, forex, or crypto asset. + * @type {string} + * @memberof GetSnapshotSummary200ResponseResultsInner */ - 'low': number; + 'name'?: string; /** - * The open value for the symbol in the given time period. - * @type {number} - * @memberof IndicesOpenClose + * + * @type {GetSnapshotSummary200ResponseResultsInnerOptions} + * @memberof GetSnapshotSummary200ResponseResultsInner */ - 'open': number; + 'options'?: GetSnapshotSummary200ResponseResultsInnerOptions; /** - * The open value of the ticker symbol in pre-market trading. + * The most up to date ticker price. * @type {number} - * @memberof IndicesOpenClose + * @memberof GetSnapshotSummary200ResponseResultsInner */ - 'preMarket'?: number; + 'price'?: number; /** - * The status of this request\'s response. - * @type {string} - * @memberof IndicesOpenClose + * + * @type {GetSnapshotSummary200ResponseResultsInnerSession} + * @memberof GetSnapshotSummary200ResponseResultsInner */ - 'status': string; + 'session'?: GetSnapshotSummary200ResponseResultsInnerSession; /** - * The exchange symbol that this item is traded under. + * Ticker of asset queried. * @type {string} - * @memberof IndicesOpenClose + * @memberof GetSnapshotSummary200ResponseResultsInner */ - 'symbol': string; + 'ticker': string; + /** + * The market for this ticker of stock, crypto, fx, option. + * @type {string} + * @memberof GetSnapshotSummary200ResponseResultsInner + */ + 'type'?: GetSnapshotSummary200ResponseResultsInnerTypeEnum; +} + +/** + * @export + * @enum {string} + */ +export enum GetSnapshotSummary200ResponseResultsInnerTypeEnum { + Stocks = 'stocks', + Crypto = 'crypto', + Options = 'options', + Fx = 'fx' } + /** * * @export - * @interface IndicesTickerResults + * @interface GetSnapshotSummary200ResponseResultsInnerBranding */ -export interface IndicesTickerResults { +export interface GetSnapshotSummary200ResponseResultsInnerBranding { /** - * An array of results containing the requested data. - * @type {Array} - * @memberof IndicesTickerResults + * A link to this ticker\'s company\'s icon. Icon\'s are generally smaller, square images that represent the company at a glance. Note that you must provide an API key when accessing this URL. See the \"Authentication\" section at the top of this page for more details. + * @type {string} + * @memberof GetSnapshotSummary200ResponseResultsInnerBranding */ - 'results'?: Array; + 'icon_url'?: string; + /** + * A link to this ticker\'s company\'s logo. Note that you must provide an API key when accessing this URL. See the \"Authentication\" section at the top of this page for more details. + * @type {string} + * @memberof GetSnapshotSummary200ResponseResultsInnerBranding + */ + 'logo_url'?: string; } /** * * @export - * @interface IndicesTickerResultsResultsInner + * @interface GetSnapshotSummary200ResponseResultsInnerOptions */ -export interface IndicesTickerResultsResultsInner { +export interface GetSnapshotSummary200ResponseResultsInnerOptions { /** - * The close value for the symbol in the given time period. - * @type {number} - * @memberof IndicesTickerResultsResultsInner + * The type of contract. Can be \"put\", \"call\", or in some rare cases, \"other\". + * @type {string} + * @memberof GetSnapshotSummary200ResponseResultsInnerOptions */ - 'c': number; + 'contract_type': GetSnapshotSummary200ResponseResultsInnerOptionsContractTypeEnum; /** - * The highest value for the symbol in the given time period. - * @type {number} - * @memberof IndicesTickerResultsResultsInner + * The exercise style of this contract. See this link for more details on exercise styles. + * @type {string} + * @memberof GetSnapshotSummary200ResponseResultsInnerOptions */ - 'h': number; + 'exercise_style': GetSnapshotSummary200ResponseResultsInnerOptionsExerciseStyleEnum; /** - * The lowest value for the symbol in the given time period. - * @type {number} - * @memberof IndicesTickerResultsResultsInner + * The contract\'s expiration date in YYYY-MM-DD format. + * @type {string} + * @memberof GetSnapshotSummary200ResponseResultsInnerOptions */ - 'l': number; + 'expiration_date': string; /** - * The number of transactions in the aggregate window. + * The number of shares per contract for this contract. * @type {number} - * @memberof IndicesTickerResultsResultsInner + * @memberof GetSnapshotSummary200ResponseResultsInnerOptions */ - 'n'?: number; + 'shares_per_contract': number; /** - * The open value for the symbol in the given time period. + * The strike price of the option contract. * @type {number} - * @memberof IndicesTickerResultsResultsInner + * @memberof GetSnapshotSummary200ResponseResultsInnerOptions */ - 'o': number; + 'strike_price': number; /** - * The Unix millisecond timestamp for the start of the aggregate window. - * @type {number} - * @memberof IndicesTickerResultsResultsInner + * The ticker for the option contract. + * @type {string} + * @memberof GetSnapshotSummary200ResponseResultsInnerOptions */ - 't': number; + 'underlying_ticker': string; } + /** - * + * @export + * @enum {string} + */ +export enum GetSnapshotSummary200ResponseResultsInnerOptionsContractTypeEnum { + Put = 'put', + Call = 'call', + Other = 'other' +} +/** + * @export + * @enum {string} + */ +export enum GetSnapshotSummary200ResponseResultsInnerOptionsExerciseStyleEnum { + American = 'american', + European = 'european', + Bermudan = 'bermudan' +} + +/** + * Comprehensive trading session metrics, detailing price changes, trading volume, and key price points (open, close, high, low) for the asset within the current trading day. Includes specific changes during early, regular, and late trading periods to enable detailed performance analysis and trend tracking. * @export - * @interface ListConditions200Response + * @interface GetSnapshotSummary200ResponseResultsInnerSession */ -export interface ListConditions200Response { +export interface GetSnapshotSummary200ResponseResultsInnerSession { /** - * The total number of results for this request. + * The value of the price change for the asset from the previous trading day. * @type {number} - * @memberof ListConditions200Response - */ - 'count': number; - /** - * If present, this value can be used to fetch the next page of data. - * @type {string} - * @memberof ListConditions200Response + * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ - 'next_url'?: string; + 'change': number; /** - * A request ID assigned by the server. - * @type {string} - * @memberof ListConditions200Response + * The percent of the price change for the asset from the previous trading day. + * @type {number} + * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ - 'request_id': string; + 'change_percent': number; /** - * An array of conditions that match your query. - * @type {Array} - * @memberof ListConditions200Response + * The closing price of the asset for the day. + * @type {number} + * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ - 'results': Array; + 'close': number; /** - * The status of this request\'s response. - * @type {string} - * @memberof ListConditions200Response + * Today\'s early trading change amount, difference between price and previous close if in early trading hours, otherwise difference between last price during early trading and previous close. + * @type {number} + * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ - 'status': string; -} -/** - * A condition generally refers to any extra information passed in a trade or a quote. These conditions may or may not affect the behavior of aggregates. - * @export - * @interface ListConditions200ResponseResultsInner - */ -export interface ListConditions200ResponseResultsInner { + 'early_trading_change'?: number; /** - * A commonly-used abbreviation for this condition. - * @type {string} - * @memberof ListConditions200ResponseResultsInner + * Today\'s early trading change as a percentage. + * @type {number} + * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ - 'abbreviation'?: string; + 'early_trading_change_percent'?: number; /** - * An identifier for a group of similar financial instruments. - * @type {string} - * @memberof ListConditions200ResponseResultsInner + * The highest price of the asset for the day. + * @type {number} + * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ - 'asset_class': ListConditions200ResponseResultsInnerAssetClassEnum; + 'high': number; /** - * Data types that this condition applies to. - * @type {Array} - * @memberof ListConditions200ResponseResultsInner + * Today\'s late trading change amount, difference between price and today\'s close if in late trading hours, otherwise difference between last price during late trading and today\'s close. + * @type {number} + * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ - 'data_types': Array; + 'late_trading_change'?: number; /** - * A short description of the semantics of this condition. - * @type {string} - * @memberof ListConditions200ResponseResultsInner + * Today\'s late trading change as a percentage. + * @type {number} + * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ - 'description'?: string; + 'late_trading_change_percent'?: number; /** - * If present, mapping this condition from a Polygon.io code to a SIP symbol depends on this attribute. In other words, data with this condition attached comes exclusively from the given exchange. + * The lowest price of the asset for the day. * @type {number} - * @memberof ListConditions200ResponseResultsInner + * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ - 'exchange'?: number; + 'low': number; /** - * An identifier used by Polygon.io for this condition. Unique per data type. + * The open price of the asset for the day. * @type {number} - * @memberof ListConditions200ResponseResultsInner + * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ - 'id': number; + 'open': number; /** - * If true, this condition is from an old version of the SIPs\' specs and no longer is used. Other conditions may or may not reuse the same symbol as this one. - * @type {boolean} - * @memberof ListConditions200ResponseResultsInner + * The closing price of the asset for the previous trading day. + * @type {number} + * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ - 'legacy'?: boolean; + 'previous_close': number; /** - * The name of this condition. - * @type {string} - * @memberof ListConditions200ResponseResultsInner + * The price of the most recent trade or bid price for this asset. + * @type {number} + * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ - 'name': string; + 'price'?: number; /** - * - * @type {ListConditions200ResponseResultsInnerSipMapping} - * @memberof ListConditions200ResponseResultsInner + * Today\'s change in regular trading hours, difference between current price and previous trading day\'s close, otherwise difference between today\'s close and previous day\'s close. + * @type {number} + * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ - 'sip_mapping': ListConditions200ResponseResultsInnerSipMapping; + 'regular_trading_change'?: number; /** - * An identifier for a collection of related conditions. - * @type {string} - * @memberof ListConditions200ResponseResultsInner + * Today\'s regular trading change as a percentage. + * @type {number} + * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ - 'type': ListConditions200ResponseResultsInnerTypeEnum; + 'regular_trading_change_percent'?: number; /** - * - * @type {ListConditions200ResponseResultsInnerUpdateRules} - * @memberof ListConditions200ResponseResultsInner + * The trading volume for the asset for the day. + * @type {number} + * @memberof GetSnapshotSummary200ResponseResultsInnerSession */ - 'update_rules'?: ListConditions200ResponseResultsInnerUpdateRules; + 'volume'?: number; } - /** - * @export - * @enum {string} - */ -export enum ListConditions200ResponseResultsInnerAssetClassEnum { - Stocks = 'stocks', - Options = 'options', - Crypto = 'crypto', - Fx = 'fx' -} -/** - * @export - * @enum {string} - */ -export enum ListConditions200ResponseResultsInnerDataTypesEnum { - Trade = 'trade', - Bbo = 'bbo', - Nbbo = 'nbbo' -} -/** - * @export - * @enum {string} - */ -export enum ListConditions200ResponseResultsInnerTypeEnum { - SaleCondition = 'sale_condition', - QuoteCondition = 'quote_condition', - SipGeneratedFlag = 'sip_generated_flag', - FinancialStatusIndicator = 'financial_status_indicator', - ShortSaleRestrictionIndicator = 'short_sale_restriction_indicator', - SettlementCondition = 'settlement_condition', - MarketCondition = 'market_condition', - TradeThruExempt = 'trade_thru_exempt' -} - -/** - * A comprehensive mapping that translates condition codes from individual SIPs (CTA, OPRA, UTP) to a unified code used by Polygon.io. This facilitates consistent interpretation and application of market data conditions across different data streams, ensuring that users can accurately apply these conditions to their data analysis and reporting. + * * @export - * @interface ListConditions200ResponseResultsInnerSipMapping + * @interface GetSnapshots200Response */ -export interface ListConditions200ResponseResultsInnerSipMapping { - /** - * Condition code from the Consolidated Tape Association (CTA). - * @type {string} - * @memberof ListConditions200ResponseResultsInnerSipMapping - */ - 'CTA'?: string; +export interface GetSnapshots200Response { /** - * Condition code from the Options Price Reporting Authority (OPRA). + * If present, this value can be used to fetch the next page of data. * @type {string} - * @memberof ListConditions200ResponseResultsInnerSipMapping + * @memberof GetSnapshots200Response */ - 'OPRA'?: string; + 'next_url'?: string; /** - * Condition code from UTP Plan (UTP). + * A request id assigned by the server. * @type {string} - * @memberof ListConditions200ResponseResultsInnerSipMapping + * @memberof GetSnapshots200Response */ - 'UTP'?: string; -} -/** - * A list of aggregation rules. - * @export - * @interface ListConditions200ResponseResultsInnerUpdateRules - */ -export interface ListConditions200ResponseResultsInnerUpdateRules { + 'request_id': string; /** - * - * @type {ListConditions200ResponseResultsInnerUpdateRulesConsolidated} - * @memberof ListConditions200ResponseResultsInnerUpdateRules + * An array of results containing the requested data. + * @type {Array} + * @memberof GetSnapshots200Response */ - 'consolidated': ListConditions200ResponseResultsInnerUpdateRulesConsolidated; + 'results'?: Array; /** - * - * @type {ListConditions200ResponseResultsInnerUpdateRulesMarketCenter} - * @memberof ListConditions200ResponseResultsInnerUpdateRules + * The status of this request\'s response. + * @type {string} + * @memberof GetSnapshots200Response */ - 'market_center': ListConditions200ResponseResultsInnerUpdateRulesMarketCenter; + 'status': string; } /** - * Describes aggregation rules on a consolidated (all exchanges) basis. + * * @export - * @interface ListConditions200ResponseResultsInnerUpdateRulesConsolidated + * @interface GetSnapshots200ResponseResultsInner */ -export interface ListConditions200ResponseResultsInnerUpdateRulesConsolidated { +export interface GetSnapshots200ResponseResultsInner { /** - * Whether or not trades with this condition update the high/low. - * @type {boolean} - * @memberof ListConditions200ResponseResultsInnerUpdateRulesConsolidated + * The price of the underlying asset for the contract to break even. For a call, this value is (strike price + premium paid). For a put, this value is (strike price - premium paid). + * @type {number} + * @memberof GetSnapshots200ResponseResultsInner */ - 'updates_high_low': boolean; + 'break_even_price'?: number; /** - * Whether or not trades with this condition update the open/close. - * @type {boolean} - * @memberof ListConditions200ResponseResultsInnerUpdateRulesConsolidated + * + * @type {GetSnapshots200ResponseResultsInnerDetails} + * @memberof GetSnapshots200ResponseResultsInner */ - 'updates_open_close': boolean; + 'details'?: GetSnapshots200ResponseResultsInnerDetails; /** - * Whether or not trades with this condition update the volume. - * @type {boolean} - * @memberof ListConditions200ResponseResultsInnerUpdateRulesConsolidated + * The error while looking for this ticker. + * @type {string} + * @memberof GetSnapshots200ResponseResultsInner */ - 'updates_volume': boolean; -} -/** - * Describes aggregation rules on a per-market-center basis. - * @export - * @interface ListConditions200ResponseResultsInnerUpdateRulesMarketCenter - */ -export interface ListConditions200ResponseResultsInnerUpdateRulesMarketCenter { + 'error'?: string; /** - * Whether or not trades with this condition update the high/low. - * @type {boolean} - * @memberof ListConditions200ResponseResultsInnerUpdateRulesMarketCenter + * Fair Market Value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInner */ - 'updates_high_low': boolean; + 'fmv'?: number; /** - * Whether or not trades with this condition update the open/close. - * @type {boolean} - * @memberof ListConditions200ResponseResultsInnerUpdateRulesMarketCenter + * If Fair Market Value (FMV) is available, this field is the nanosecond timestamp of the last FMV calculation. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInner */ - 'updates_open_close': boolean; + 'fmv_last_updated'?: number; /** - * Whether or not trades with this condition update the volume. - * @type {boolean} - * @memberof ListConditions200ResponseResultsInnerUpdateRulesMarketCenter + * + * @type {GetSnapshots200ResponseResultsInnerGreeks} + * @memberof GetSnapshots200ResponseResultsInner */ - 'updates_volume': boolean; -} -/** - * - * @export - * @interface ListConditions400Response - */ -export interface ListConditions400Response { + 'greeks'?: GetSnapshots200ResponseResultsInnerGreeks; /** - * The total number of results for this request. + * The market\'s forecast for the volatility of the underlying asset, based on this option\'s current price. * @type {number} - * @memberof ListConditions400Response + * @memberof GetSnapshots200ResponseResultsInner */ - 'count': number; + 'implied_volatility'?: number; /** - * If present, this value can be used to fetch the next page of data. - * @type {string} - * @memberof ListConditions400Response + * + * @type {GetSnapshots200ResponseResultsInnerLastMinute} + * @memberof GetSnapshots200ResponseResultsInner */ - 'next_url'?: string; + 'last_minute'?: GetSnapshots200ResponseResultsInnerLastMinute; /** - * A request ID assigned by the server. - * @type {string} - * @memberof ListConditions400Response + * + * @type {GetSnapshots200ResponseResultsInnerLastQuote} + * @memberof GetSnapshots200ResponseResultsInner */ - 'request_id': string; + 'last_quote'?: GetSnapshots200ResponseResultsInnerLastQuote; /** - * An array of conditions that match your query. - * @type {Array} - * @memberof ListConditions400Response + * + * @type {GetSnapshots200ResponseResultsInnerLastTrade} + * @memberof GetSnapshots200ResponseResultsInner */ - 'results': Array; + 'last_trade'?: GetSnapshots200ResponseResultsInnerLastTrade; /** - * The status of this request\'s response. - * @type {string} - * @memberof ListConditions400Response + * The nanosecond timestamp of when this information was updated. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInner */ - 'status': string; -} -/** - * A list of dividends. - * @export - * @interface ListDividends200Response - */ -export interface ListDividends200Response { + 'last_updated'?: number; /** - * If present, this value can be used to fetch the next page of data. + * The market status for the market that trades this ticker. Possible values for stocks, options, crypto, and forex snapshots are open, closed, early_trading, or late_trading. Possible values for indices snapshots are regular_trading, closed, early_trading, and late_trading. * @type {string} - * @memberof ListDividends200Response + * @memberof GetSnapshots200ResponseResultsInner */ - 'next_url'?: string; + 'market_status'?: string; /** - * A request id assigned by the server. + * The error message while looking for this ticker. * @type {string} - * @memberof ListDividends200Response - */ - 'request_id': string; - /** - * An array of results containing the requested data. - * @type {Array} - * @memberof ListDividends200Response + * @memberof GetSnapshots200ResponseResultsInner */ - 'results'?: Array; + 'message'?: string; /** - * The status of this request\'s response. + * The name of this contract. * @type {string} - * @memberof ListDividends200Response + * @memberof GetSnapshots200ResponseResultsInner */ - 'status'?: string; -} -/** - * - * @export - * @interface ListDividends200ResponseResultsInner - */ -export interface ListDividends200ResponseResultsInner { + 'name'?: string; /** - * The cash amount of the dividend per share owned. + * The quantity of this contract held at the end of the last trading day. * @type {number} - * @memberof ListDividends200ResponseResultsInner + * @memberof GetSnapshots200ResponseResultsInner */ - 'cash_amount': number; + 'open_interest'?: number; /** - * The currency in which the dividend is paid. - * @type {string} - * @memberof ListDividends200ResponseResultsInner + * + * @type {GetSnapshotSummary200ResponseResultsInnerSession} + * @memberof GetSnapshots200ResponseResultsInner */ - 'currency'?: string; + 'session'?: GetSnapshotSummary200ResponseResultsInnerSession; /** - * The date that the dividend was announced. + * The ticker symbol for the asset. * @type {string} - * @memberof ListDividends200ResponseResultsInner + * @memberof GetSnapshots200ResponseResultsInner */ - 'declaration_date'?: string; + 'ticker': string; /** - * The type of dividend. Dividends that have been paid and/or are expected to be paid on consistent schedules are denoted as CD. Special Cash dividends that have been paid that are infrequent or unusual, and/or can not be expected to occur in the future are denoted as SC. Long-Term and Short-Term capital gain distributions are denoted as LT and ST, respectively. + * The time relevance of the data. * @type {string} - * @memberof ListDividends200ResponseResultsInner + * @memberof GetSnapshots200ResponseResultsInner */ - 'dividend_type': ListDividends200ResponseResultsInnerDividendTypeEnum; + 'timeframe'?: GetSnapshots200ResponseResultsInnerTimeframeEnum; /** - * The date that the stock first trades without the dividend, determined by the exchange. + * The asset class for this ticker. * @type {string} - * @memberof ListDividends200ResponseResultsInner + * @memberof GetSnapshots200ResponseResultsInner */ - 'ex_dividend_date': string; + 'type'?: GetSnapshots200ResponseResultsInnerTypeEnum; /** - * The number of times per year the dividend is paid out. Possible values are 0 (one-time), 1 (annually), 2 (bi-annually), 4 (quarterly), 12 (monthly), 24 (bi-monthly), and 52 (weekly). - * @type {number} - * @memberof ListDividends200ResponseResultsInner + * + * @type {GetSnapshots200ResponseResultsInnerUnderlyingAsset} + * @memberof GetSnapshots200ResponseResultsInner */ - 'frequency': number; + 'underlying_asset'?: GetSnapshots200ResponseResultsInnerUnderlyingAsset; /** - * The unique identifier of the dividend. - * @type {string} - * @memberof ListDividends200ResponseResultsInner - */ - 'id': string; - /** - * The date that the dividend is paid out. - * @type {string} - * @memberof ListDividends200ResponseResultsInner - */ - 'pay_date'?: string; - /** - * The date that the stock must be held to receive the dividend, set by the company. - * @type {string} - * @memberof ListDividends200ResponseResultsInner - */ - 'record_date'?: string; - /** - * The ticker symbol of the dividend. - * @type {string} - * @memberof ListDividends200ResponseResultsInner + * Value of Index. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInner */ - 'ticker': string; + 'value'?: number; } /** * @export * @enum {string} */ -export enum ListDividends200ResponseResultsInnerDividendTypeEnum { - Cd = 'CD', - Sc = 'SC', - Lt = 'LT', - St = 'ST' +export enum GetSnapshots200ResponseResultsInnerTimeframeEnum { + Delayed = 'DELAYED', + RealTime = 'REAL-TIME' } - /** - * - * @export - * @interface ListExchanges200Response - */ -export interface ListExchanges200Response { - /** - * The total number of results for this request. - * @type {number} - * @memberof ListExchanges200Response - */ - 'count'?: number; - /** - * A request ID assigned by the server. - * @type {string} - * @memberof ListExchanges200Response - */ - 'request_id': string; - /** - * An array of results containing the requested data. - * @type {Array} - * @memberof ListExchanges200Response - */ - 'results'?: Array; - /** - * The status of this request\'s response. - * @type {string} - * @memberof ListExchanges200Response - */ - 'status': string; + * @export + * @enum {string} + */ +export enum GetSnapshots200ResponseResultsInnerTypeEnum { + Stocks = 'stocks', + Options = 'options', + Fx = 'fx', + Crypto = 'crypto', + Indices = 'indices' } + /** - * An entity that reports trades. + * The details for this contract. * @export - * @interface ListExchanges200ResponseResultsInner + * @interface GetSnapshots200ResponseResultsInnerDetails */ -export interface ListExchanges200ResponseResultsInner { - /** - * A commonly used abbreviation for this exchange. - * @type {string} - * @memberof ListExchanges200ResponseResultsInner - */ - 'acronym'?: string; - /** - * An identifier for a group of similar financial instruments. - * @type {string} - * @memberof ListExchanges200ResponseResultsInner - */ - 'asset_class': ListExchanges200ResponseResultsInnerAssetClassEnum; - /** - * A unique identifier used by Polygon.io for this exchange. - * @type {number} - * @memberof ListExchanges200ResponseResultsInner - */ - 'id': number; - /** - * An identifier for a geographical location. - * @type {string} - * @memberof ListExchanges200ResponseResultsInner - */ - 'locale': ListExchanges200ResponseResultsInnerLocaleEnum; - /** - * The Market Identifier Code of this exchange (see ISO 10383). - * @type {string} - * @memberof ListExchanges200ResponseResultsInner - */ - 'mic'?: string; +export interface GetSnapshots200ResponseResultsInnerDetails { /** - * Name of this exchange. + * The type of contract. Can be \"put\", \"call\", or in some rare cases, \"other\". * @type {string} - * @memberof ListExchanges200ResponseResultsInner + * @memberof GetSnapshots200ResponseResultsInnerDetails */ - 'name': string; + 'contract_type': GetSnapshots200ResponseResultsInnerDetailsContractTypeEnum; /** - * The MIC of the entity that operates this exchange. + * The exercise style of this contract. See this link for more details on exercise styles. * @type {string} - * @memberof ListExchanges200ResponseResultsInner + * @memberof GetSnapshots200ResponseResultsInnerDetails */ - 'operating_mic'?: string; + 'exercise_style': GetSnapshots200ResponseResultsInnerDetailsExerciseStyleEnum; /** - * The ID used by SIP\'s to represent this exchange. + * The contract\'s expiration date in YYYY-MM-DD format. * @type {string} - * @memberof ListExchanges200ResponseResultsInner + * @memberof GetSnapshots200ResponseResultsInnerDetails */ - 'participant_id'?: string; + 'expiration_date': string; /** - * Represents the type of exchange. - * @type {string} - * @memberof ListExchanges200ResponseResultsInner + * The number of shares per contract for this contract. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInnerDetails */ - 'type': ListExchanges200ResponseResultsInnerTypeEnum; + 'shares_per_contract': number; /** - * A link to this exchange\'s website, if one exists. - * @type {string} - * @memberof ListExchanges200ResponseResultsInner + * The strike price of the option contract. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInnerDetails */ - 'url'?: string; + 'strike_price': number; } /** * @export * @enum {string} */ -export enum ListExchanges200ResponseResultsInnerAssetClassEnum { - Stocks = 'stocks', - Options = 'options', - Crypto = 'crypto', - Fx = 'fx', - Futures = 'futures' -} -/** - * @export - * @enum {string} - */ -export enum ListExchanges200ResponseResultsInnerLocaleEnum { - Us = 'us', - Global = 'global' +export enum GetSnapshots200ResponseResultsInnerDetailsContractTypeEnum { + Put = 'put', + Call = 'call', + Other = 'other' } /** * @export * @enum {string} */ -export enum ListExchanges200ResponseResultsInnerTypeEnum { - Exchange = 'exchange', - Trf = 'TRF', - Sip = 'SIP' +export enum GetSnapshots200ResponseResultsInnerDetailsExerciseStyleEnum { + American = 'american', + European = 'european', + Bermudan = 'bermudan' } /** - * + * The greeks for this contract. There are certain circumstances where greeks will not be returned, such as options contracts that are deep in the money. See this article for more information. * @export - * @interface ListExchanges400Response + * @interface GetSnapshots200ResponseResultsInnerGreeks */ -export interface ListExchanges400Response { +export interface GetSnapshots200ResponseResultsInnerGreeks { /** - * The total number of results for this request. + * The change in the option\'s price per $0.01 increment in the price of the underlying asset. * @type {number} - * @memberof ListExchanges400Response + * @memberof GetSnapshots200ResponseResultsInnerGreeks */ - 'count'?: number; + 'delta': number; /** - * A request ID assigned by the server. - * @type {string} - * @memberof ListExchanges400Response + * The change in delta per $0.01 change in the price of the underlying asset. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInnerGreeks */ - 'request_id': string; + 'gamma': number; /** - * The status of this request\'s response. - * @type {string} - * @memberof ListExchanges400Response + * The change in the option\'s price per day. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInnerGreeks */ - 'status': string; + 'theta': number; + /** + * The change in the option\'s price per 1% increment in volatility. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInnerGreeks + */ + 'vega': number; } /** - * + * The most recent minute aggregate for this stock. * @export - * @interface ListFinancials200Response + * @interface GetSnapshots200ResponseResultsInnerLastMinute */ -export interface ListFinancials200Response { +export interface GetSnapshots200ResponseResultsInnerLastMinute { /** - * The total number of results for this request. + * The closing value for the minute aggreate. * @type {number} - * @memberof ListFinancials200Response + * @memberof GetSnapshots200ResponseResultsInnerLastMinute */ - 'count': number; + 'close': number; /** - * If present, this value can be used to fetch the next page of data. - * @type {string} - * @memberof ListFinancials200Response + * The highest value for the minute aggregate. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInnerLastMinute */ - 'next_url'?: string; + 'high': number; /** - * A request id assigned by the server. - * @type {string} - * @memberof ListFinancials200Response + * The lowest value for the minute aggregate. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInnerLastMinute */ - 'request_id': string; + 'low': number; /** - * An array of results containing the requested data. - * @type {Array} - * @memberof ListFinancials200Response + * The open value for the minute aggregate. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInnerLastMinute */ - 'results': Array; + 'open': number; /** - * The status of this request\'s response. - * @type {string} - * @memberof ListFinancials200Response + * The number of transactions that took place within the minute aggregate. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInnerLastMinute */ - 'status': string; -} -/** - * - * @export - * @interface ListFinancials200ResponseResultsInner - */ -export interface ListFinancials200ResponseResultsInner { + 'transactions': number; /** - * The datetime (EST timezone) the filing was accepted by EDGAR in YYYYMMDDHHMMSS format. - * @type {string} - * @memberof ListFinancials200ResponseResultsInner + * The trading volume for the minute aggregate. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInnerLastMinute */ - 'acceptance_datetime'?: string; - /** - * The CIK number for the company. - * @type {string} - * @memberof ListFinancials200ResponseResultsInner - */ - 'cik': string; - /** - * The company name. - * @type {string} - * @memberof ListFinancials200ResponseResultsInner - */ - 'company_name': string; - /** - * The end date of the period that these financials cover in YYYYMMDD format. - * @type {string} - * @memberof ListFinancials200ResponseResultsInner - */ - 'end_date'?: string; + 'volume': number; /** - * The date that the SEC filing which these financials were derived from was made available. Note that this is not necessarily the date when this information became public, as some companies may publish a press release before filing with the SEC. - * @type {string} - * @memberof ListFinancials200ResponseResultsInner + * The trading volume weighted average price for the minute aggregate. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInnerLastMinute */ - 'filing_date'?: string; + 'vwap': number; +} +/** + * The most recent quote for this contract. This is only returned if your current plan includes quotes. + * @export + * @interface GetSnapshots200ResponseResultsInnerLastQuote + */ +export interface GetSnapshots200ResponseResultsInnerLastQuote { /** - * - * @type {ListFinancials200ResponseResultsInnerFinancials} - * @memberof ListFinancials200ResponseResultsInner + * The ask price. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInnerLastQuote */ - 'financials': ListFinancials200ResponseResultsInnerFinancials; + 'ask': number; /** - * Fiscal period of the report according to the company (Q1, Q2, Q3, Q4, or FY). - * @type {string} - * @memberof ListFinancials200ResponseResultsInner + * The ask side exchange ID. See Exchanges for Massive.com\'s mapping of exchange IDs. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInnerLastQuote */ - 'fiscal_period': string; + 'ask_exchange'?: number; /** - * Fiscal year of the report according to the company. - * @type {string} - * @memberof ListFinancials200ResponseResultsInner + * The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInnerLastQuote */ - 'fiscal_year'?: string; + 'ask_size'?: number; /** - * The Standard Industrial Classification (SIC) code for the company. - * @type {string} - * @memberof ListFinancials200ResponseResultsInner + * The bid price. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInnerLastQuote */ - 'sic'?: string; + 'bid': number; /** - * The URL of the specific XBRL instance document within the SEC filing that these financials were derived from. - * @type {string} - * @memberof ListFinancials200ResponseResultsInner + * The bid side exchange ID. See Exchanges for Massive.com\'s mapping of exchange IDs. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInnerLastQuote */ - 'source_filing_file_url'?: string; + 'bid_exchange'?: number; /** - * The URL of the SEC filing that these financials were derived from. - * @type {string} - * @memberof ListFinancials200ResponseResultsInner + * The bid size. This represents the number of round lot orders at the given bid price. The normal round lot size is 100 shares. A bid size of 2 means there are 200 shares for purchase at the given bid price. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInnerLastQuote */ - 'source_filing_url'?: string; + 'bid_size'?: number; /** - * The start date of the period that these financials cover in YYYYMMDD format. - * @type {string} - * @memberof ListFinancials200ResponseResultsInner + * The nanosecond timestamp of when this information was updated. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInnerLastQuote */ - 'start_date'?: string; + 'last_updated': number; /** - * The list of ticker symbols for the company. - * @type {Array} - * @memberof ListFinancials200ResponseResultsInner + * The average of the bid and ask price. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInnerLastQuote */ - 'tickers'?: Array; + 'midpoint'?: number; /** - * The timeframe of the report (quarterly, annual or ttm). + * The time relevance of the data. * @type {string} - * @memberof ListFinancials200ResponseResultsInner + * @memberof GetSnapshots200ResponseResultsInnerLastQuote */ - 'timeframe': string; + 'timeframe': GetSnapshots200ResponseResultsInnerLastQuoteTimeframeEnum; } + /** - * Structured financial statements with detailed data points and metadata. + * @export + * @enum {string} + */ +export enum GetSnapshots200ResponseResultsInnerLastQuoteTimeframeEnum { + Delayed = 'DELAYED', + RealTime = 'REAL-TIME' +} + +/** + * The most recent quote for this contract. This is only returned if your current plan includes trades. * @export - * @interface ListFinancials200ResponseResultsInnerFinancials + * @interface GetSnapshots200ResponseResultsInnerLastTrade */ -export interface ListFinancials200ResponseResultsInnerFinancials { +export interface GetSnapshots200ResponseResultsInnerLastTrade { /** - * - * @type {ListFinancials200ResponseResultsInnerFinancialsBalanceSheet} - * @memberof ListFinancials200ResponseResultsInnerFinancials + * A list of condition codes. + * @type {Array} + * @memberof GetSnapshots200ResponseResultsInnerLastTrade */ - 'balance_sheet'?: ListFinancials200ResponseResultsInnerFinancialsBalanceSheet; + 'conditions'?: Array; /** - * Cash flow statement. The keys in this object can be any of the fields listed in the Cash Flow Statement section of the financials API glossary of terms. See the attributes of the objects within `balance_sheet` for more details. - * @type {object} - * @memberof ListFinancials200ResponseResultsInnerFinancials + * The exchange ID. See Exchanges for Massive.com\'s mapping of exchange IDs. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInnerLastTrade */ - 'cash_flow_statement'?: object; + 'exchange'?: number; /** - * Comprehensive income. The keys in this object can be any of the fields listed in the Comprehensive Income section of the financials API glossary of terms. See the attributes of the objects within `balance_sheet` for more details. - * @type {object} - * @memberof ListFinancials200ResponseResultsInnerFinancials + * The Trade ID which uniquely identifies a trade. These are unique per combination of ticker, exchange, and TRF. For example: A trade for AAPL executed on NYSE and a trade for AAPL executed on NASDAQ could potentially have the same Trade ID. + * @type {string} + * @memberof GetSnapshots200ResponseResultsInnerLastTrade */ - 'comprehensive_income'?: object; + 'id'?: string; /** - * Income statement. The keys in this object can be any of the fields listed in the Income Statement section of the financials API glossary of terms. See the attributes of the objects within `balance_sheet` for more details. - * @type {object} - * @memberof ListFinancials200ResponseResultsInnerFinancials + * The nanosecond timestamp of when this information was updated. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInnerLastTrade */ - 'income_statement'?: object; -} -/** - * Balance sheet. The keys in this object can be any of the fields listed in the Balance Sheet section of the financials API glossary of terms. - * @export - * @interface ListFinancials200ResponseResultsInnerFinancialsBalanceSheet - */ -export interface ListFinancials200ResponseResultsInnerFinancialsBalanceSheet { + 'last_updated'?: number; /** - * - * @type {ListFinancials200ResponseResultsInnerFinancialsBalanceSheet} - * @memberof ListFinancials200ResponseResultsInnerFinancialsBalanceSheet + * The nanosecond Exchange Unix Timestamp. This is the timestamp of when the trade was generated at the exchange. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInnerLastTrade */ - '*'?: ListFinancials200ResponseResultsInnerFinancialsBalanceSheet; -} -/** - * - * @export - * @interface ListIPOs200Response - */ -export interface ListIPOs200Response { + 'participant_timestamp'?: number; /** - * If present, this value can be used to fetch the next page of data. - * @type {string} - * @memberof ListIPOs200Response + * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInnerLastTrade */ - 'next_url'?: string; + 'price': number; /** - * A request id assigned by the server. - * @type {string} - * @memberof ListIPOs200Response + * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this trade from the exchange which produced it. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInnerLastTrade */ - 'request_id'?: string; + 'sip_timestamp'?: number; /** - * An array of results containing the requested data. - * @type {Array} - * @memberof ListIPOs200Response + * The size of a trade (also known as volume). + * @type {number} + * @memberof GetSnapshots200ResponseResultsInnerLastTrade */ - 'results'?: Array; + 'size': number; /** - * The status of this request\'s response. + * The time relevance of the data. * @type {string} - * @memberof ListIPOs200Response + * @memberof GetSnapshots200ResponseResultsInnerLastTrade */ - 'status'?: string; + 'timeframe'?: GetSnapshots200ResponseResultsInnerLastTradeTimeframeEnum; } + /** - * + * @export + * @enum {string} + */ +export enum GetSnapshots200ResponseResultsInnerLastTradeTimeframeEnum { + Delayed = 'DELAYED', + RealTime = 'REAL-TIME' +} + +/** + * Information on the underlying stock for this options contract. The market data returned depends on your current stocks plan. * @export - * @interface ListIPOs200ResponseResultsInner + * @interface GetSnapshots200ResponseResultsInnerUnderlyingAsset */ -export interface ListIPOs200ResponseResultsInner { - /** - * The date when the IPO event was announced. - * @type {string} - * @memberof ListIPOs200ResponseResultsInner - */ - 'announced_date'?: string; +export interface GetSnapshots200ResponseResultsInnerUnderlyingAsset { /** - * Underlying currency of the security. - * @type {string} - * @memberof ListIPOs200ResponseResultsInner + * The change in price for the contract to break even. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInnerUnderlyingAsset */ - 'currency_code'?: string; + 'change_to_break_even': number; /** - * The price set by the company and its underwriters before the IPO goes live. + * The nanosecond timestamp of when this information was updated. * @type {number} - * @memberof ListIPOs200ResponseResultsInner + * @memberof GetSnapshots200ResponseResultsInnerUnderlyingAsset */ - 'final_issue_price'?: number; + 'last_updated'?: number; /** - * The highest price within the IPO price range that the company might use to price the shares. + * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. * @type {number} - * @memberof ListIPOs200ResponseResultsInner + * @memberof GetSnapshots200ResponseResultsInnerUnderlyingAsset */ - 'highest_offer_price'?: number; + 'price'?: number; /** - * The status of the IPO event. IPO events start out as status \"rumor\" or \"pending\". On listing day, the status changes to \"new\". After the listing day, the status changes to \"history\". The status \"direct_listing_process\" corresponds to a type of offering where, instead of going through all the IPO processes, the company decides to list its shares directly on an exchange, without using an investment bank or other intermediaries. This is called a direct listing, direct placement, or direct public offering (DPO). + * The ticker symbol for the contract\'s underlying asset. * @type {string} - * @memberof ListIPOs200ResponseResultsInner + * @memberof GetSnapshots200ResponseResultsInnerUnderlyingAsset */ - 'ipo_status': ListIPOs200ResponseResultsInnerIpoStatusEnum; + 'ticker': string; /** - * International Securities Identification Number. This is a unique twelve-digit code that is assigned to every security issuance in the world. + * The time relevance of the data. * @type {string} - * @memberof ListIPOs200ResponseResultsInner + * @memberof GetSnapshots200ResponseResultsInnerUnderlyingAsset */ - 'isin'?: string; + 'timeframe'?: GetSnapshots200ResponseResultsInnerUnderlyingAssetTimeframeEnum; /** - * Name of issuer. - * @type {string} - * @memberof ListIPOs200ResponseResultsInner - */ - 'issuer_name': string; - /** - * The date when the IPO event was last modified. - * @type {string} - * @memberof ListIPOs200ResponseResultsInner + * The value of the underlying index. + * @type {number} + * @memberof GetSnapshots200ResponseResultsInnerUnderlyingAsset */ - 'last_updated': string; + 'value'?: number; +} + +/** + * @export + * @enum {string} + */ +export enum GetSnapshots200ResponseResultsInnerUnderlyingAssetTimeframeEnum { + Delayed = 'DELAYED', + RealTime = 'REAL-TIME' +} + +/** + * + * @export + * @interface GetStocksAggregates200Response + */ +export interface GetStocksAggregates200Response { /** - * First trading date for the newly listed entity. + * The exchange symbol that this item is traded under. * @type {string} - * @memberof ListIPOs200ResponseResultsInner + * @memberof GetStocksAggregates200Response */ - 'listing_date'?: string; + 'ticker': string; /** - * The minimum number of shares that can be bought or sold in a single transaction. - * @type {number} - * @memberof ListIPOs200ResponseResultsInner + * Whether or not this response was adjusted for splits. + * @type {boolean} + * @memberof GetStocksAggregates200Response */ - 'lot_size'?: number; + 'adjusted': boolean; /** - * The lowest price within the IPO price range that the company is willing to offer its shares to investors. + * The number of aggregates (minute or day) used to generate the response. * @type {number} - * @memberof ListIPOs200ResponseResultsInner + * @memberof GetStocksAggregates200Response */ - 'lowest_offer_price'?: number; + 'queryCount': number; /** - * The upper limit of the shares that the company is offering to investors. - * @type {number} - * @memberof ListIPOs200ResponseResultsInner + * A request id assigned by the server. + * @type {string} + * @memberof GetStocksAggregates200Response */ - 'max_shares_offered'?: number; + 'request_id': string; /** - * The lower limit of shares that the company is willing to sell in the IPO. + * The total number of results for this request. * @type {number} - * @memberof ListIPOs200ResponseResultsInner + * @memberof GetStocksAggregates200Response */ - 'min_shares_offered'?: number; + 'resultsCount': number; /** - * Market Identifier Code (MIC) of the primary exchange where the security is listed. The Market Identifier Code (MIC) (ISO 10383) is a unique identification code used to identify securities trading exchanges, regulated and non-regulated trading markets. + * The status of this request\'s response. * @type {string} - * @memberof ListIPOs200ResponseResultsInner + * @memberof GetStocksAggregates200Response */ - 'primary_exchange'?: string; + 'status': string; /** - * Description of the security. - * @type {string} - * @memberof ListIPOs200ResponseResultsInner + * An array of results containing the requested data. + * @type {Array} + * @memberof GetStocksAggregates200Response */ - 'security_description'?: string; + 'results'?: Array; /** - * The classification of the stock. For example, \"CS\" stands for Common Stock. + * If present, this value can be used to fetch the next page of data. * @type {string} - * @memberof ListIPOs200ResponseResultsInner + * @memberof GetStocksAggregates200Response */ - 'security_type': string; + 'next_url'?: string; +} +/** + * + * @export + * @interface GetStocksAggregates200ResponseAllOfResultsInner + */ +export interface GetStocksAggregates200ResponseAllOfResultsInner { /** - * The total number of shares that the company has issued and are held by investors. + * The close price for the symbol in the given time period. * @type {number} - * @memberof ListIPOs200ResponseResultsInner + * @memberof GetStocksAggregates200ResponseAllOfResultsInner */ - 'shares_outstanding'?: number; + 'c': number; /** - * The ticker symbol of the IPO event. - * @type {string} - * @memberof ListIPOs200ResponseResultsInner + * The highest price for the symbol in the given time period. + * @type {number} + * @memberof GetStocksAggregates200ResponseAllOfResultsInner */ - 'ticker': string; + 'h': number; /** - * The total amount raised by the company for IPO. + * The lowest price for the symbol in the given time period. * @type {number} - * @memberof ListIPOs200ResponseResultsInner + * @memberof GetStocksAggregates200ResponseAllOfResultsInner */ - 'total_offer_size'?: number; + 'l': number; /** - * This is a unique nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades. - * @type {string} - * @memberof ListIPOs200ResponseResultsInner + * The number of transactions in the aggregate window. + * @type {number} + * @memberof GetStocksAggregates200ResponseAllOfResultsInner */ - 'us_code'?: string; -} - -/** - * @export - * @enum {string} - */ -export enum ListIPOs200ResponseResultsInnerIpoStatusEnum { - DirectListingProcess = 'direct_listing_process', - History = 'history', - New = 'new', - Pending = 'pending', - Postponed = 'postponed', - Rumor = 'rumor', - Withdrawn = 'withdrawn' + 'n'?: number; + /** + * The open price for the symbol in the given time period. + * @type {number} + * @memberof GetStocksAggregates200ResponseAllOfResultsInner + */ + 'o': number; + /** + * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. + * @type {boolean} + * @memberof GetStocksAggregates200ResponseAllOfResultsInner + */ + 'otc'?: boolean; + /** + * The Unix millisecond timestamp for the start of the aggregate window. + * @type {number} + * @memberof GetStocksAggregates200ResponseAllOfResultsInner + */ + 't': number; + /** + * The trading volume of the symbol in the given time period. + * @type {number} + * @memberof GetStocksAggregates200ResponseAllOfResultsInner + */ + 'v': number; + /** + * The volume weighted average price. + * @type {number} + * @memberof GetStocksAggregates200ResponseAllOfResultsInner + */ + 'vw'?: number; } - /** * * @export - * @interface ListNews200Response + * @interface GetStocksFinancialsV1BalanceSheets200Response */ -export interface ListNews200Response { - /** - * The total number of results for this request. - * @type {number} - * @memberof ListNews200Response - */ - 'count'?: number; +export interface GetStocksFinancialsV1BalanceSheets200Response { /** - * If present, this value can be used to fetch the next page of data. + * If present, this value can be used to fetch the next page. * @type {string} - * @memberof ListNews200Response + * @memberof GetStocksFinancialsV1BalanceSheets200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} - * @memberof ListNews200Response + * @memberof GetStocksFinancialsV1BalanceSheets200Response */ - 'request_id'?: string; + 'request_id': string; /** - * An array of results containing the requested data. - * @type {Array} - * @memberof ListNews200Response + * The results for this request. + * @type {Array} + * @memberof GetStocksFinancialsV1BalanceSheets200Response */ - 'results'?: Array; + 'results': Array; /** * The status of this request\'s response. * @type {string} - * @memberof ListNews200Response + * @memberof GetStocksFinancialsV1BalanceSheets200Response */ - 'status'?: string; + 'status': GetStocksFinancialsV1BalanceSheets200ResponseStatusEnum; +} + +/** + * @export + * @enum {string} + */ +export enum GetStocksFinancialsV1BalanceSheets200ResponseStatusEnum { + Ok = 'OK' } + /** * * @export - * @interface ListNews200ResponseResultsInner + * @interface GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ -export interface ListNews200ResponseResultsInner { +export interface GetStocksFinancialsV1BalanceSheets200ResponseResultsInner { /** - * The mobile friendly Accelerated Mobile Page (AMP) URL. - * @type {string} - * @memberof ListNews200ResponseResultsInner + * Amounts owed to suppliers and vendors for goods and services purchased on credit. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'amp_url'?: string; + 'accounts_payable'?: number; /** - * A link to the news article. - * @type {string} - * @memberof ListNews200ResponseResultsInner + * Current liabilities not classified elsewhere, including accrued expenses, taxes payable, and other obligations due within one year. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'article_url': string; + 'accrued_and_other_current_liabilities'?: number; /** - * The article\'s author. - * @type {string} - * @memberof ListNews200ResponseResultsInner + * Cumulative gains and losses that bypass the income statement, including foreign currency translation adjustments and unrealized gains/losses on securities. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'author': string; + 'accumulated_other_comprehensive_income'?: number; /** - * A description of the article. - * @type {string} - * @memberof ListNews200ResponseResultsInner + * Amount received from shareholders in excess of the par or stated value of shares issued. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'description'?: string; + 'additional_paid_in_capital'?: number; /** - * Unique identifier for the article. - * @type {string} - * @memberof ListNews200ResponseResultsInner + * Cash on hand and short-term, highly liquid investments that are readily convertible to known amounts of cash. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'id': string; + 'cash_and_equivalents'?: number; /** - * The article\'s image URL. + * The company\'s Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company\'s CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup). * @type {string} - * @memberof ListNews200ResponseResultsInner + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'image_url'?: string; + 'cik'?: string; /** - * The insights related to the article. - * @type {Array} - * @memberof ListNews200ResponseResultsInner + * Disclosed amount related to contractual commitments and potential liabilities that may arise from uncertain future events. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'insights'?: Array; + 'commitments_and_contingencies'?: number; /** - * The keywords associated with the article (which will vary depending on the publishing source). - * @type {Array} - * @memberof ListNews200ResponseResultsInner + * Par or stated value of common shares outstanding representing basic ownership in the company. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'keywords'?: Array; + 'common_stock'?: number; /** - * The UTC date and time when the article was published, formatted in RFC3339 standard (e.g. YYYY-MM-DDTHH:MM:SSZ). + * Short-term borrowings and the current portion of long-term debt due within one year. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner + */ + 'debt_current'?: number; + /** + * Customer payments received in advance for goods or services to be delivered within one year. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner + */ + 'deferred_revenue_current'?: number; + /** + * The date when the financial statement was filed with the SEC. * @type {string} - * @memberof ListNews200ResponseResultsInner + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'published_utc': string; + 'filing_date'?: string; /** - * - * @type {ListNews200ResponseResultsInnerPublisher} - * @memberof ListNews200ResponseResultsInner + * The fiscal quarter number (1, 2, 3, or 4) for the reporting period. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'publisher': ListNews200ResponseResultsInnerPublisher; + 'fiscal_quarter'?: number; /** - * The ticker symbols associated with the article. - * @type {Array} - * @memberof ListNews200ResponseResultsInner + * The fiscal year for the reporting period. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'tickers': Array; + 'fiscal_year'?: number; /** - * The title of the news article. - * @type {string} - * @memberof ListNews200ResponseResultsInner + * Intangible asset representing the excess of purchase price over fair value of net assets acquired in business combinations. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'title': string; -} -/** - * - * @export - * @interface ListNews200ResponseResultsInnerInsightsInner - */ -export interface ListNews200ResponseResultsInnerInsightsInner { + 'goodwill'?: number; /** - * The sentiment of the insight. - * @type {string} - * @memberof ListNews200ResponseResultsInnerInsightsInner + * Intangible assets other than goodwill, including patents, trademarks, and customer relationships, net of accumulated amortization. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'sentiment': ListNews200ResponseResultsInnerInsightsInnerSentimentEnum; + 'intangible_assets_net'?: number; /** - * The reasoning behind the sentiment. - * @type {string} - * @memberof ListNews200ResponseResultsInnerInsightsInner + * Raw materials, work-in-process, and finished goods held for sale in the ordinary course of business. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'sentiment_reasoning': string; + 'inventories'?: number; /** - * The ticker symbol associated with the insight. - * @type {string} - * @memberof ListNews200ResponseResultsInnerInsightsInner + * Long-term borrowings and capital lease obligations with maturities greater than one year. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'ticker': string; -} - -/** - * @export - * @enum {string} - */ -export enum ListNews200ResponseResultsInnerInsightsInnerSentimentEnum { - Positive = 'positive', - Neutral = 'neutral', - Negative = 'negative' -} - -/** - * Details the source of the news article, including the publisher\'s name, logo, and homepage URLs. This information helps users identify and access the original source of news content. - * @export - * @interface ListNews200ResponseResultsInnerPublisher - */ -export interface ListNews200ResponseResultsInnerPublisher { + 'long_term_debt_and_capital_lease_obligations'?: number; /** - * The publisher\'s homepage favicon URL. - * @type {string} - * @memberof ListNews200ResponseResultsInnerPublisher + * Equity in consolidated subsidiaries not owned by the parent company, representing minority shareholders\' ownership. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'favicon_url'?: string; + 'noncontrolling_interest'?: number; /** - * The publisher\'s homepage URL. - * @type {string} - * @memberof ListNews200ResponseResultsInnerPublisher + * Non-current assets not classified elsewhere, including long-term investments, deferred tax assets, and other long-term assets. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'homepage_url': string; + 'other_assets'?: number; /** - * The publisher\'s logo URL. - * @type {string} - * @memberof ListNews200ResponseResultsInnerPublisher + * Current assets not classified elsewhere, including prepaid expenses, taxes receivable, and other assets expected to be converted to cash within one year. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'logo_url': string; + 'other_current_assets'?: number; /** - * The publisher\'s name. - * @type {string} - * @memberof ListNews200ResponseResultsInnerPublisher + * Equity components not classified elsewhere in shareholders\' equity. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'name': string; -} -/** - * @type ListNewsPublishedUtcParameter - * @export - */ -export type ListNewsPublishedUtcParameter = string; - -/** - * - * @export - * @interface ListOptionsContracts200Response - */ -export interface ListOptionsContracts200Response { + 'other_equity'?: number; /** - * If present, this value can be used to fetch the next page of data. - * @type {string} - * @memberof ListOptionsContracts200Response + * Non-current liabilities not classified elsewhere, including deferred tax liabilities, pension obligations, and other long-term liabilities. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'next_url'?: string; + 'other_noncurrent_liabilities'?: number; /** - * A request id assigned by the server. + * The last date of the reporting period, representing the specific point in time when the balance sheet snapshot was taken. * @type {string} - * @memberof ListOptionsContracts200Response - */ - 'request_id'?: string; - /** - * An array of results containing the requested data. - * @type {Array} - * @memberof ListOptionsContracts200Response + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'results'?: Array; + 'period_end'?: string; /** - * The status of this request\'s response. - * @type {string} - * @memberof ListOptionsContracts200Response + * Par or stated value of preferred shares outstanding with preferential rights over common stock. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'status'?: string; -} -/** - * Contains the requested data for the specified options contract. - * @export - * @interface ListOptionsContracts200ResponseResultsInner - */ -export interface ListOptionsContracts200ResponseResultsInner { + 'preferred_stock'?: number; /** - * If an option contract has additional underlyings or deliverables associated with it, they will appear here. See here for some examples of what might cause a contract to have additional underlyings. - * @type {Array} - * @memberof ListOptionsContracts200ResponseResultsInner + * Tangible fixed assets used in operations, reported net of accumulated depreciation. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'additional_underlyings'?: Array; + 'property_plant_equipment_net'?: number; /** - * The 6 letter CFI code of the contract (defined in ISO 10962) - * @type {string} - * @memberof ListOptionsContracts200ResponseResultsInner + * Amounts owed to the company by customers and other parties, primarily accounts receivable, net of allowances for doubtful accounts. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'cfi'?: string; + 'receivables'?: number; /** - * The type of contract. Can be \"put\", \"call\", or in some rare cases, \"other\". - * @type {string} - * @memberof ListOptionsContracts200ResponseResultsInner + * Cumulative net income earned by the company less dividends paid to shareholders since inception. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'contract_type'?: string; + 'retained_earnings_deficit'?: number; /** - * The correction number for this option contract. + * Marketable securities and other investments with maturities of one year or less that are not classified as cash equivalents. * @type {number} - * @memberof ListOptionsContracts200ResponseResultsInner + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'correction'?: number; + 'short_term_investments'?: number; /** - * The exercise style of this contract. See this link for more details on exercise styles. - * @type {string} - * @memberof ListOptionsContracts200ResponseResultsInner + * A list of ticker symbols under which the company is listed. Multiple symbols may indicate different share classes for the same company. + * @type {Array} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'exercise_style'?: ListOptionsContracts200ResponseResultsInnerExerciseStyleEnum; + 'tickers'?: Array; /** - * The contract\'s expiration date in YYYY-MM-DD format. + * The reporting period type. Possible values include: quarterly, annual. * @type {string} - * @memberof ListOptionsContracts200ResponseResultsInner + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'expiration_date'?: string; + 'timeframe': string; /** - * The MIC code of the primary exchange that this contract is listed on. - * @type {string} - * @memberof ListOptionsContracts200ResponseResultsInner + * Sum of all current and non-current assets representing everything the company owns or controls. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'primary_exchange'?: string; + 'total_assets'?: number; /** - * The number of shares per contract for this contract. + * Sum of all current assets expected to be converted to cash, sold, or consumed within one year. * @type {number} - * @memberof ListOptionsContracts200ResponseResultsInner + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'shares_per_contract'?: number; + 'total_current_assets'?: number; /** - * The strike price of the option contract. + * Sum of all liabilities expected to be settled within one year. * @type {number} - * @memberof ListOptionsContracts200ResponseResultsInner + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'strike_price'?: number; + 'total_current_liabilities'?: number; /** - * The ticker for the option contract. - * @type {string} - * @memberof ListOptionsContracts200ResponseResultsInner + * Sum of all equity components representing shareholders\' total ownership interest in the company. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'ticker'?: string; + 'total_equity'?: number; /** - * The underlying ticker that the option contract relates to. - * @type {string} - * @memberof ListOptionsContracts200ResponseResultsInner + * Total shareholders\' equity attributable to the parent company, excluding noncontrolling interests. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'underlying_ticker'?: string; -} - -/** - * @export - * @enum {string} - */ -export enum ListOptionsContracts200ResponseResultsInnerExerciseStyleEnum { - American = 'american', - European = 'european', - Bermudan = 'bermudan' -} - -/** - * - * @export - * @interface ListOptionsContracts200ResponseResultsInnerAdditionalUnderlyingsInner - */ -export interface ListOptionsContracts200ResponseResultsInnerAdditionalUnderlyingsInner { + 'total_equity_attributable_to_parent'?: number; /** - * The number of shares per contract of the additional underlying, or the cash-in-lieu amount of the currency. + * Sum of all current and non-current liabilities representing everything the company owes. * @type {number} - * @memberof ListOptionsContracts200ResponseResultsInnerAdditionalUnderlyingsInner + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'amount'?: number; + 'total_liabilities'?: number; /** - * The type of the additional underlying asset, either equity or currency. - * @type {string} - * @memberof ListOptionsContracts200ResponseResultsInnerAdditionalUnderlyingsInner + * Sum of total liabilities and total equity, which should equal total assets per the fundamental accounting equation. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'type'?: string; + 'total_liabilities_and_equity'?: number; /** - * The name of the additional underlying asset. - * @type {string} - * @memberof ListOptionsContracts200ResponseResultsInnerAdditionalUnderlyingsInner + * Cost of the company\'s own shares that have been repurchased and are held in treasury, typically reported as a negative value. + * @type {number} + * @memberof GetStocksFinancialsV1BalanceSheets200ResponseResultsInner */ - 'underlying'?: string; + 'treasury_stock'?: number; } /** * * @export - * @interface ListStockSplits200Response + * @interface GetStocksFinancialsV1CashFlowStatements200Response */ -export interface ListStockSplits200Response { +export interface GetStocksFinancialsV1CashFlowStatements200Response { /** - * If present, this value can be used to fetch the next page of data. + * If present, this value can be used to fetch the next page. * @type {string} - * @memberof ListStockSplits200Response + * @memberof GetStocksFinancialsV1CashFlowStatements200Response */ 'next_url'?: string; /** * A request id assigned by the server. * @type {string} - * @memberof ListStockSplits200Response + * @memberof GetStocksFinancialsV1CashFlowStatements200Response */ - 'request_id'?: string; + 'request_id': string; /** - * An array of results containing the requested data. - * @type {Array} - * @memberof ListStockSplits200Response + * The results for this request. + * @type {Array} + * @memberof GetStocksFinancialsV1CashFlowStatements200Response */ - 'results'?: Array; + 'results': Array; /** * The status of this request\'s response. * @type {string} - * @memberof ListStockSplits200Response + * @memberof GetStocksFinancialsV1CashFlowStatements200Response */ - 'status'?: string; + 'status': GetStocksFinancialsV1CashFlowStatements200ResponseStatusEnum; +} + +/** + * @export + * @enum {string} + */ +export enum GetStocksFinancialsV1CashFlowStatements200ResponseStatusEnum { + Ok = 'OK' } + /** * * @export - * @interface ListStockSplits200ResponseResultsInner + * @interface GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ -export interface ListStockSplits200ResponseResultsInner { +export interface GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner { /** - * The execution date of the stock split. On this date the stock split was applied. - * @type {string} - * @memberof ListStockSplits200ResponseResultsInner + * Cash generated from continuing business operations before discontinued operations. + * @type {number} + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'execution_date': string; + 'cash_from_operating_activities_continuing_operations'?: number; /** - * The unique identifier for this stock split. - * @type {string} - * @memberof ListStockSplits200ResponseResultsInner + * Net change in cash and cash equivalents during the period, representing the sum of operating, investing, and financing cash flows plus currency effects. + * @type {number} + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'id': string; + 'change_in_cash_and_equivalents'?: number; /** - * The second number in the split ratio. For example: In a 2-for-1 split, split_from would be 1. + * Net change in working capital components including accounts receivable, inventory, accounts payable, and other operating items. * @type {number} - * @memberof ListStockSplits200ResponseResultsInner + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'split_from': number; + 'change_in_other_operating_assets_and_liabilities_net'?: number; /** - * The first number in the split ratio. For example: In a 2-for-1 split, split_to would be 2. + * The company\'s Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company’s CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup). + * @type {string} + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner + */ + 'cik'?: string; + /** + * Non-cash charges for the reduction in value of tangible and intangible assets over time. * @type {number} - * @memberof ListStockSplits200ResponseResultsInner + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'split_to': number; + 'depreciation_depletion_and_amortization'?: number; /** - * The ticker symbol of the stock split. - * @type {string} - * @memberof ListStockSplits200ResponseResultsInner + * Cash payments to shareholders in the form of dividends, typically reported as negative values. + * @type {number} + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'ticker': string; -} -/** - * - * @export - * @interface ListTickerTypes200Response - */ -export interface ListTickerTypes200Response { + 'dividends'?: number; /** - * The total number of results for this request. + * Impact of foreign exchange rate changes on cash and cash equivalents denominated in foreign currencies. * @type {number} - * @memberof ListTickerTypes200Response + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'count'?: number; + 'effect_of_currency_exchange_rate'?: number; /** - * A request ID assigned by the server. + * The date when the financial statement was filed with the SEC. * @type {string} - * @memberof ListTickerTypes200Response + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'request_id': string; + 'filing_date'?: string; /** - * - * @type {Array} - * @memberof ListTickerTypes200Response + * The fiscal quarter number (1, 2, 3, or 4) for the reporting period. + * @type {number} + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'results'?: Array; + 'fiscal_quarter'?: number; /** - * The status of this request\'s response. - * @type {string} - * @memberof ListTickerTypes200Response + * The fiscal year for the reporting period. + * @type {number} + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'status': string; -} -/** - * Describes the type of financial instrument represented by a ticker. - * @export - * @interface ListTickerTypes200ResponseResultsInner - */ -export interface ListTickerTypes200ResponseResultsInner { + 'fiscal_year'?: number; /** - * An identifier for a group of similar financial instruments. - * @type {string} - * @memberof ListTickerTypes200ResponseResultsInner + * After-tax income or loss from business operations that have been discontinued. + * @type {number} + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'asset_class': ListTickerTypes200ResponseResultsInnerAssetClassEnum; + 'income_loss_from_discontinued_operations'?: number; /** - * A code used by Polygon.io to refer to this ticker type. - * @type {string} - * @memberof ListTickerTypes200ResponseResultsInner + * Net cash flows from issuing or repaying long-term debt obligations. + * @type {number} + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'code': string; + 'long_term_debt_issuances_repayments'?: number; /** - * A short description of this ticker type. - * @type {string} - * @memberof ListTickerTypes200ResponseResultsInner + * Total cash generated or used by financing activities, including debt issuance, debt repayment, dividends, and share transactions. + * @type {number} + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'description': string; + 'net_cash_from_financing_activities'?: number; /** - * An identifier for a geographical location. - * @type {string} - * @memberof ListTickerTypes200ResponseResultsInner + * Cash flows from financing activities of continuing operations before discontinued operations. + * @type {number} + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'locale': ListTickerTypes200ResponseResultsInnerLocaleEnum; -} - -/** - * @export - * @enum {string} - */ -export enum ListTickerTypes200ResponseResultsInnerAssetClassEnum { - Stocks = 'stocks', - Options = 'options', - Crypto = 'crypto', - Fx = 'fx', - Indices = 'indices' -} -/** - * @export - * @enum {string} - */ -export enum ListTickerTypes200ResponseResultsInnerLocaleEnum { - Us = 'us', - Global = 'global' -} - -/** - * - * @export - * @interface ListTickers200Response - */ -export interface ListTickers200Response { + 'net_cash_from_financing_activities_continuing_operations'?: number; /** - * The total number of results for this request. + * Cash flows from financing activities of discontinued business segments. * @type {number} - * @memberof ListTickers200Response + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'count'?: number; + 'net_cash_from_financing_activities_discontinued_operations'?: number; /** - * If present, this value can be used to fetch the next page of data. - * @type {string} - * @memberof ListTickers200Response + * Total cash generated or used by investing activities, including capital expenditures, acquisitions, and asset sales. + * @type {number} + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'next_url'?: string; + 'net_cash_from_investing_activities'?: number; /** - * A request id assigned by the server. - * @type {string} - * @memberof ListTickers200Response + * Cash flows from investing activities of continuing operations before discontinued operations. + * @type {number} + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'request_id'?: string; + 'net_cash_from_investing_activities_continuing_operations'?: number; /** - * An array of tickers that match your query. Note: Although you can query by CUSIP, due to legal reasons we do not return the CUSIP in the response. - * @type {Array} - * @memberof ListTickers200Response + * Cash flows from investing activities of discontinued business segments. + * @type {number} + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'results'?: Array; + 'net_cash_from_investing_activities_discontinued_operations'?: number; /** - * The status of this request\'s response. - * @type {string} - * @memberof ListTickers200Response + * Total cash generated or used by operating activities, representing cash flow from core business operations. + * @type {number} + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'status'?: string; -} -/** - * - * @export - * @interface ListTickers200ResponseResultsInner - */ -export interface ListTickers200ResponseResultsInner { + 'net_cash_from_operating_activities'?: number; /** - * Whether or not the asset is actively traded. False means the asset has been delisted. - * @type {boolean} - * @memberof ListTickers200ResponseResultsInner + * Cash flows from operating activities of discontinued business segments. + * @type {number} + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'active'?: boolean; + 'net_cash_from_operating_activities_discontinued_operations'?: number; /** - * The CIK number for this ticker. Find more information [here](https://en.wikipedia.org/wiki/Central_Index_Key). - * @type {string} - * @memberof ListTickers200ResponseResultsInner + * Net income used as the starting point for operating cash flow calculations. + * @type {number} + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'cik'?: string; + 'net_income'?: number; /** - * The composite OpenFIGI number for this ticker. Find more information [here](https://www.openfigi.com/about/figi) - * @type {string} - * @memberof ListTickers200ResponseResultsInner + * Cash flows related to minority shareholders in consolidated subsidiaries. + * @type {number} + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'composite_figi'?: string; + 'noncontrolling_interests'?: number; /** - * The name of the currency that this asset is traded with. - * @type {string} - * @memberof ListTickers200ResponseResultsInner + * Other miscellaneous adjustments to cash flows not classified elsewhere. + * @type {number} + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'currency_name'?: string; + 'other_cash_adjustments'?: number; /** - * The last date that the asset was traded. - * @type {string} - * @memberof ListTickers200ResponseResultsInner + * Cash flows from financing activities not classified elsewhere, including share repurchases and other equity transactions. + * @type {number} + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'delisted_utc'?: string; + 'other_financing_activities'?: number; /** - * The information is accurate up to this time. - * @type {string} - * @memberof ListTickers200ResponseResultsInner + * Cash flows from investing activities not classified elsewhere, including acquisitions, divestitures, and investments. + * @type {number} + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'last_updated_utc'?: string; + 'other_investing_activities'?: number; /** - * The locale of the asset. - * @type {string} - * @memberof ListTickers200ResponseResultsInner + * Other adjustments to reconcile net income to operating cash flow not classified elsewhere. + * @type {number} + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'locale': ListTickers200ResponseResultsInnerLocaleEnum; + 'other_operating_activities'?: number; /** - * The market type of the asset. + * The last date of the reporting period (formatted as YYYY-MM-DD). * @type {string} - * @memberof ListTickers200ResponseResultsInner + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'market': ListTickers200ResponseResultsInnerMarketEnum; + 'period_end'?: string; /** - * The name of the asset. For stocks/equities this will be the companies registered name. For crypto/fx this will be the name of the currency or coin pair. - * @type {string} - * @memberof ListTickers200ResponseResultsInner + * Cash outflows for capital expenditures on fixed assets, typically reported as negative values. + * @type {number} + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'name': string; + 'purchase_of_property_plant_and_equipment'?: number; /** - * The Market Identifier Code (MIC) of the primary listing exchange for this asset (see [ISO 10383](https://www.iso20022.org/market-identifier-codes)). - * @type {string} - * @memberof ListTickers200ResponseResultsInner + * Cash inflows from disposing of fixed assets, typically reported as positive values. + * @type {number} + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'primary_exchange'?: string; + 'sale_of_property_plant_and_equipment'?: number; /** - * The share Class OpenFIGI number for this ticker. Find more information [here](https://www.openfigi.com/about/figi) - * @type {string} - * @memberof ListTickers200ResponseResultsInner + * Net cash flows from issuing or repaying short-term debt obligations. + * @type {number} + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'share_class_figi'?: string; + 'short_term_debt_issuances_repayments'?: number; /** - * The exchange symbol that this item is traded under. - * @type {string} - * @memberof ListTickers200ResponseResultsInner + * A list of ticker symbols under which the company is listed. Multiple symbols may indicate different share classes for the same company. + * @type {Array} + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'ticker': string; + 'tickers'?: Array; /** - * The type of the asset. Find the types that we support via our [Ticker Types API](https://polygon.io/docs/stocks/get_v3_reference_tickers_types). + * The reporting period type. Possible values include: quarterly, annual, trailing_twelve_months. * @type {string} - * @memberof ListTickers200ResponseResultsInner - */ - 'type'?: string; -} - -/** - * @export - * @enum {string} - */ -export enum ListTickers200ResponseResultsInnerLocaleEnum { - Us = 'us', - Global = 'global' -} -/** - * @export - * @enum {string} - */ -export enum ListTickers200ResponseResultsInnerMarketEnum { - Stocks = 'stocks', - Crypto = 'crypto', - Fx = 'fx', - Otc = 'otc', - Indices = 'indices' -} - -/** - * - * @export - * @interface Locales - */ -export interface Locales { - /** - * - * @type {Array} - * @memberof Locales + * @memberof GetStocksFinancialsV1CashFlowStatements200ResponseResultsInner */ - 'results'?: Array; + 'timeframe'?: string; } /** * * @export - * @interface LocalesResultsInner + * @interface GetStocksFinancialsV1IncomeStatements200Response */ -export interface LocalesResultsInner { +export interface GetStocksFinancialsV1IncomeStatements200Response { /** - * An abbreviated country name. + * If present, this value can be used to fetch the next page. * @type {string} - * @memberof LocalesResultsInner + * @memberof GetStocksFinancialsV1IncomeStatements200Response */ - 'locale'?: string; + 'next_url'?: string; /** - * The name of the country. + * A request id assigned by the server. * @type {string} - * @memberof LocalesResultsInner + * @memberof GetStocksFinancialsV1IncomeStatements200Response */ - 'name'?: string; -} -/** - * A dynamic key from the results set - * @export - * @interface MapKey - */ -export interface MapKey { + 'request_id': string; /** - * The descriptive name of this results key - * @type {string} - * @memberof MapKey + * The results for this request. + * @type {Array} + * @memberof GetStocksFinancialsV1IncomeStatements200Response */ - 'name'?: string; + 'results': Array; /** - * The data type of this results key + * The status of this request\'s response. * @type {string} - * @memberof MapKey + * @memberof GetStocksFinancialsV1IncomeStatements200Response */ - 'type'?: MapKeyTypeEnum; + 'status': GetStocksFinancialsV1IncomeStatements200ResponseStatusEnum; } /** * @export * @enum {string} */ -export enum MapKeyTypeEnum { - String = 'string', - Int = 'int', - Int64 = 'int64', - Float64 = 'float64' +export enum GetStocksFinancialsV1IncomeStatements200ResponseStatusEnum { + Ok = 'OK' } /** * * @export - * @interface MarketHolidayInner + * @interface GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ -export interface MarketHolidayInner { +export interface GetStocksFinancialsV1IncomeStatements200ResponseResultsInner { /** - * The market close time on the holiday (if it\'s not closed). - * @type {string} - * @memberof MarketHolidayInner + * Earnings per share calculated using the weighted average number of basic shares outstanding. For TTM records, recalculated as TTM net income divided by average basic shares outstanding over the four quarters. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'close'?: string; + 'basic_earnings_per_share'?: number; /** - * The date of the holiday. - * @type {string} - * @memberof MarketHolidayInner + * Weighted average number of common shares outstanding during the period, used in basic EPS calculation. For TTM records, represents the average over the four most recent quarters. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'date': string; + 'basic_shares_outstanding'?: number; /** - * Which market the record is for. + * The company\'s Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company’s CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup). * @type {string} - * @memberof MarketHolidayInner + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'exchange': string; + 'cik'?: string; /** - * The name of the holiday. - * @type {string} - * @memberof MarketHolidayInner + * Total net income or loss for the consolidated entity including all subsidiaries. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'name': string; + 'consolidated_net_income_loss'?: number; /** - * The market open time on the holiday (if it\'s not closed). - * @type {string} - * @memberof MarketHolidayInner + * Direct costs attributable to the production of goods or services sold, also known as cost of goods sold (COGS). + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'open'?: string; + 'cost_of_revenue'?: number; /** - * The status of the market on the holiday. - * @type {string} - * @memberof MarketHolidayInner + * Non-cash expenses representing the allocation of asset costs over their useful lives. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'status': string; -} -/** - * - * @export - * @interface MarketStatus - */ -export interface MarketStatus { + 'depreciation_depletion_amortization'?: number; /** - * Whether or not the market is in post-market hours. - * @type {boolean} - * @memberof MarketStatus + * Earnings per share calculated using diluted shares outstanding, including the effect of potentially dilutive securities. For TTM records, recalculated as TTM net income divided by average diluted shares outstanding over the four quarters. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'afterHours'?: boolean; + 'diluted_earnings_per_share'?: number; /** - * - * @type {MarketStatusCurrencies} - * @memberof MarketStatus + * Weighted average number of shares outstanding including the dilutive effect of stock options, warrants, and convertible securities. For TTM records, represents the average over the four most recent quarters. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'currencies'?: MarketStatusCurrencies; + 'diluted_shares_outstanding'?: number; /** - * Whether or not the market is in pre-market hours. - * @type {boolean} - * @memberof MarketStatus + * After-tax results from business segments that have been or will be disposed of. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'earlyHours'?: boolean; + 'discontinued_operations'?: number; /** - * - * @type {MarketStatusExchanges} - * @memberof MarketStatus + * Earnings before interest, taxes, depreciation, and amortization, a measure of operating performance. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'exchanges'?: MarketStatusExchanges; + 'ebitda'?: number; /** - * The status of the market as a whole. - * @type {string} - * @memberof MarketStatus + * The company\'s share of income or losses from equity method investments in affiliated companies. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'market'?: string; + 'equity_in_affiliates'?: number; /** - * The current time of the server. - * @type {string} - * @memberof MarketStatus + * Unusual and infrequent gains or losses that are both unusual in nature and infrequent in occurrence. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'serverTime'?: string; -} -/** - * - * @export - * @interface MarketStatusCurrencies - */ -export interface MarketStatusCurrencies { + 'extraordinary_items'?: number; /** - * The status of the crypto market. + * The date when the financial statement was filed with the SEC. * @type {string} - * @memberof MarketStatusCurrencies + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'crypto'?: string; + 'filing_date'?: string; /** - * The status of the forex market. - * @type {string} - * @memberof MarketStatusCurrencies + * The fiscal quarter number (1, 2, 3, or 4) for the reporting period. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'fx'?: string; -} -/** - * - * @export - * @interface MarketStatusExchanges - */ -export interface MarketStatusExchanges { + 'fiscal_quarter'?: number; /** - * The status of the Nasdaq market. - * @type {string} - * @memberof MarketStatusExchanges + * The fiscal year for the reporting period. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'nasdaq'?: string; + 'fiscal_year'?: number; /** - * The status of the NYSE market. - * @type {string} - * @memberof MarketStatusExchanges + * Revenue minus cost of revenue, representing profit before operating expenses. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'nyse'?: string; + 'gross_profit'?: number; /** - * The status of the OTC market. - * @type {string} - * @memberof MarketStatusExchanges + * Pre-tax income calculated as operating income plus total other income/expense. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'otc'?: string; -} -/** - * - * @export - * @interface Markets - */ -export interface Markets { + 'income_before_income_taxes'?: number; /** - * A list of supported markets. - * @type {Array} - * @memberof Markets + * Income tax expense or benefit for the period. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'results'?: Array; -} -/** - * - * @export - * @interface MarketsResultsInner - */ -export interface MarketsResultsInner { + 'income_taxes'?: number; /** - * A description of the market. - * @type {string} - * @memberof MarketsResultsInner + * Cost of borrowed funds, including interest on debt and other financing obligations. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'desc'?: string; + 'interest_expense'?: number; /** - * The name of the market. - * @type {string} - * @memberof MarketsResultsInner + * Income earned from interest-bearing investments and cash equivalents. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'market'?: string; -} -/** - * @type ModelDate - * @export - */ -export type ModelDate = string; - -/** - * A mapping of the keys returned in the results to their descriptive name and data types. - * @export - * @interface ModelMap - */ -export interface ModelMap { + 'interest_income'?: number; /** - * - * @type {MapKey} - * @memberof ModelMap + * Net income or loss available to common shareholders after preferred dividends and noncontrolling interests. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'key'?: MapKey; -} -/** - * - * @export - * @interface NewsInner - */ -export interface NewsInner { + 'net_income_loss_attributable_common_shareholders'?: number; /** - * A URL of the image for the news article, if found. - * @type {string} - * @memberof NewsInner + * The portion of net income attributable to minority shareholders in consolidated subsidiaries. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'image'?: string; + 'noncontrolling_interest'?: number; /** - * A list of common keywords related to the news article. - * @type {Array} - * @memberof NewsInner + * Income from operations calculated as gross profit minus total operating expenses, excluding non-operating items. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'keywords'?: Array; + 'operating_income'?: number; /** - * The publication source of the article. - * @type {string} - * @memberof NewsInner + * Non-operating income and expenses not related to the company\'s core business operations. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'source'?: string; + 'other_income_expense'?: number; /** - * A summary of the news article. + * Operating expenses not classified in the main expense categories. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner + */ + 'other_operating_expenses'?: number; + /** + * The last date of the reporting period (formatted as YYYY-MM-DD). * @type {string} - * @memberof NewsInner + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'summary'?: string; + 'period_end'?: string; /** - * A list of ticker symbols relating to the article. + * Dividends declared on preferred stock during the period. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner + */ + 'preferred_stock_dividends_declared'?: number; + /** + * Expenses incurred for research and development activities to create new products or improve existing ones. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner + */ + 'research_development'?: number; + /** + * Total revenue or net sales for the period, representing the company\'s gross income from operations. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner + */ + 'revenue'?: number; + /** + * Expenses related to selling products and general administrative costs not directly tied to production. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner + */ + 'selling_general_administrative'?: number; + /** + * A list of ticker symbols under which the company is listed. Multiple symbols may indicate different share classes for the same company. * @type {Array} - * @memberof NewsInner + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'symbols'?: Array; + 'tickers'?: Array; /** - * The timestamp of the news article. + * The reporting period type. Possible values include: quarterly, annual, trailing_twelve_months. * @type {string} - * @memberof NewsInner + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'timestamp'?: string; + 'timeframe'?: string; /** - * The title of the news article. - * @type {string} - * @memberof NewsInner + * Sum of all operating expenses including cost of revenue, SG&A, R&D, depreciation, and other operating expenses. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'title'?: string; + 'total_operating_expenses'?: number; /** - * A direct link to the news article from its source publication. - * @type {string} - * @memberof NewsInner + * Net total of all non-operating income and expenses including interest income, interest expense, and other items. + * @type {number} + * @memberof GetStocksFinancialsV1IncomeStatements200ResponseResultsInner */ - 'url'?: string; + 'total_other_income_expense'?: number; } /** * * @export - * @interface PaginationHooksBase + * @interface GetStocksFinancialsV1Ratios200Response */ -export interface PaginationHooksBase { +export interface GetStocksFinancialsV1Ratios200Response { /** - * If present, this value can be used to fetch the next page of data. + * If present, this value can be used to fetch the next page. * @type {string} - * @memberof PaginationHooksBase + * @memberof GetStocksFinancialsV1Ratios200Response */ 'next_url'?: string; + /** + * A request id assigned by the server. + * @type {string} + * @memberof GetStocksFinancialsV1Ratios200Response + */ + 'request_id': string; + /** + * The results for this request. + * @type {Array} + * @memberof GetStocksFinancialsV1Ratios200Response + */ + 'results': Array; + /** + * The status of this request\'s response. + * @type {string} + * @memberof GetStocksFinancialsV1Ratios200Response + */ + 'status': GetStocksFinancialsV1Ratios200ResponseStatusEnum; +} + +/** + * @export + * @enum {string} + */ +export enum GetStocksFinancialsV1Ratios200ResponseStatusEnum { + Ok = 'OK' } + /** * * @export - * @interface RatingSection + * @interface GetStocksFinancialsV1Ratios200ResponseResultsInner */ -export interface RatingSection { +export interface GetStocksFinancialsV1Ratios200ResponseResultsInner { /** - * Analyst Rating at current month + * Average trading volume over the last 30 trading days, providing context for liquidity. * @type {number} - * @memberof RatingSection + * @memberof GetStocksFinancialsV1Ratios200ResponseResultsInner */ - 'current': number; + 'average_volume'?: number; /** - * Analyst Ratings at 1 month in the future + * Cash ratio, calculated as cash and cash equivalents divided by current liabilities, measuring the most liquid form of liquidity coverage. * @type {number} - * @memberof RatingSection + * @memberof GetStocksFinancialsV1Ratios200ResponseResultsInner */ - 'month1': number; + 'cash'?: number; /** - * Analyst Ratings at 2 month in the future - * @type {number} - * @memberof RatingSection + * Central Index Key (CIK) number assigned by the SEC to identify the company. + * @type {string} + * @memberof GetStocksFinancialsV1Ratios200ResponseResultsInner */ - 'month2': number; + 'cik'?: string; /** - * Analyst Ratings at 3 month in the future + * Current ratio, calculated as total current assets divided by total current liabilities, measuring short-term liquidity. * @type {number} - * @memberof RatingSection + * @memberof GetStocksFinancialsV1Ratios200ResponseResultsInner */ - 'month3': number; + 'current'?: number; /** - * Analyst Ratings at 4 month in the future - * @type {number} - * @memberof RatingSection + * Date for which the ratios are calculated, representing the trading date with available price data. + * @type {string} + * @memberof GetStocksFinancialsV1Ratios200ResponseResultsInner */ - 'month4'?: number; + 'date': string; /** - * Analyst Ratings at 5 month in the future + * Debt-to-equity ratio, calculated as total debt (current debt plus long-term debt) divided by total shareholders\' equity, measuring financial leverage. * @type {number} - * @memberof RatingSection + * @memberof GetStocksFinancialsV1Ratios200ResponseResultsInner */ - 'month5'?: number; -} -/** - * - * @export - * @interface RequestIdBase - */ -export interface RequestIdBase { + 'debt_to_equity'?: number; /** - * A request id assigned by the server. - * @type {string} - * @memberof RequestIdBase + * Dividend yield, calculated as annual dividends per share divided by stock price, measuring the income return on investment. + * @type {number} + * @memberof GetStocksFinancialsV1Ratios200ResponseResultsInner */ - 'request_id': string; -} -/** - * - * @export - * @interface SnapshotMinOHLCV - */ -export interface SnapshotMinOHLCV { + 'dividend_yield'?: number; /** - * The close price for the symbol in the given time period. + * Earnings per share, calculated as net income available to common shareholders divided by weighted shares outstanding. * @type {number} - * @memberof SnapshotMinOHLCV + * @memberof GetStocksFinancialsV1Ratios200ResponseResultsInner */ - 'c'?: number; + 'earnings_per_share'?: number; /** - * The highest price for the symbol in the given time period. + * Enterprise value, calculated as market capitalization plus total debt minus cash and cash equivalents, representing total company value. * @type {number} - * @memberof SnapshotMinOHLCV + * @memberof GetStocksFinancialsV1Ratios200ResponseResultsInner */ - 'h'?: number; + 'enterprise_value'?: number; /** - * The lowest price for the symbol in the given time period. + * Enterprise value to EBITDA ratio, calculated as enterprise value divided by EBITDA, measuring company valuation relative to earnings before interest, taxes, depreciation, and amortization. * @type {number} - * @memberof SnapshotMinOHLCV + * @memberof GetStocksFinancialsV1Ratios200ResponseResultsInner */ - 'l'?: number; + 'ev_to_ebitda'?: number; /** - * The number of transactions in the aggregate window. + * Enterprise value to sales ratio, calculated as enterprise value divided by revenue, measuring company valuation relative to sales. * @type {number} - * @memberof SnapshotMinOHLCV + * @memberof GetStocksFinancialsV1Ratios200ResponseResultsInner */ - 'n'?: number; + 'ev_to_sales'?: number; /** - * The open price for the symbol in the given time period. + * Free cash flow, calculated as operating cash flow minus capital expenditures (purchase of property, plant, and equipment). * @type {number} - * @memberof SnapshotMinOHLCV + * @memberof GetStocksFinancialsV1Ratios200ResponseResultsInner */ - 'o'?: number; + 'free_cash_flow'?: number; /** - * The Unix millisecond timestamp for the start of the aggregate window. + * Market capitalization, calculated as stock price multiplied by total shares outstanding. * @type {number} - * @memberof SnapshotMinOHLCV + * @memberof GetStocksFinancialsV1Ratios200ResponseResultsInner */ - 't'?: number; + 'market_cap'?: number; /** - * The trading volume of the symbol in the given time period. + * Stock price used in ratio calculations, typically the closing price for the given date. * @type {number} - * @memberof SnapshotMinOHLCV + * @memberof GetStocksFinancialsV1Ratios200ResponseResultsInner */ - 'v'?: number; -} -/** - * - * @export - * @interface SnapshotOHLCV - */ -export interface SnapshotOHLCV { + 'price': number; /** - * The close price for the symbol in the given time period. + * Price-to-book ratio, calculated as stock price divided by book value per share, comparing market value to book value. * @type {number} - * @memberof SnapshotOHLCV + * @memberof GetStocksFinancialsV1Ratios200ResponseResultsInner */ - 'c': number; + 'price_to_book'?: number; /** - * The highest price for the symbol in the given time period. + * Price-to-cash-flow ratio, calculated as stock price divided by operating cash flow per share. Only calculated when operating cash flow per share is positive. * @type {number} - * @memberof SnapshotOHLCV + * @memberof GetStocksFinancialsV1Ratios200ResponseResultsInner */ - 'h': number; + 'price_to_cash_flow'?: number; /** - * The lowest price for the symbol in the given time period. + * Price-to-earnings ratio, calculated as stock price divided by earnings per share. Only calculated when earnings per share is positive. * @type {number} - * @memberof SnapshotOHLCV + * @memberof GetStocksFinancialsV1Ratios200ResponseResultsInner */ - 'l': number; + 'price_to_earnings'?: number; /** - * The open price for the symbol in the given time period. + * Price-to-free-cash-flow ratio, calculated as stock price divided by free cash flow per share. Only calculated when free cash flow per share is positive. * @type {number} - * @memberof SnapshotOHLCV + * @memberof GetStocksFinancialsV1Ratios200ResponseResultsInner */ - 'o': number; + 'price_to_free_cash_flow'?: number; /** - * The trading volume of the symbol in the given time period. + * Price-to-sales ratio, calculated as stock price divided by revenue per share, measuring valuation relative to sales. * @type {number} - * @memberof SnapshotOHLCV + * @memberof GetStocksFinancialsV1Ratios200ResponseResultsInner */ - 'v': number; -} -/** - * - * @export - * @interface SnapshotOHLCVVW - */ -export interface SnapshotOHLCVVW { + 'price_to_sales'?: number; /** - * The close price for the symbol in the given time period. + * Quick ratio (acid-test ratio), calculated as (current assets minus inventories) divided by current liabilities, measuring immediate liquidity. * @type {number} - * @memberof SnapshotOHLCVVW + * @memberof GetStocksFinancialsV1Ratios200ResponseResultsInner */ - 'c': number; + 'quick'?: number; /** - * The highest price for the symbol in the given time period. + * Return on assets ratio, calculated as net income divided by total assets, measuring how efficiently a company uses its assets to generate profit. * @type {number} - * @memberof SnapshotOHLCVVW + * @memberof GetStocksFinancialsV1Ratios200ResponseResultsInner */ - 'h': number; + 'return_on_assets'?: number; /** - * The lowest price for the symbol in the given time period. + * Return on equity ratio, calculated as net income divided by total shareholders\' equity, measuring profitability relative to shareholders\' equity. * @type {number} - * @memberof SnapshotOHLCVVW + * @memberof GetStocksFinancialsV1Ratios200ResponseResultsInner */ - 'l': number; + 'return_on_equity'?: number; /** - * The open price for the symbol in the given time period. - * @type {number} - * @memberof SnapshotOHLCVVW + * Stock ticker symbol for the company. + * @type {string} + * @memberof GetStocksFinancialsV1Ratios200ResponseResultsInner */ - 'o': number; + 'ticker': string; +} +/** + * + * @export + * @interface GetStocksQuotes200Response + */ +export interface GetStocksQuotes200Response { /** - * The trading volume of the symbol in the given time period. - * @type {number} - * @memberof SnapshotOHLCVVW + * If present, this value can be used to fetch the next page of data. + * @type {string} + * @memberof GetStocksQuotes200Response */ - 'v': number; + 'next_url'?: string; /** - * The volume weighted average price. - * @type {number} - * @memberof SnapshotOHLCVVW + * A request id assigned by the server. + * @type {string} + * @memberof GetStocksQuotes200Response */ - 'vw': number; + 'request_id'?: string; + /** + * An array of results containing the requested data. + * @type {Array} + * @memberof GetStocksQuotes200Response + */ + 'results'?: Array; + /** + * The status of this request\'s response. + * @type {string} + * @memberof GetStocksQuotes200Response + */ + 'status': string; } /** * * @export - * @interface SnapshotOHLCVVWOtc + * @interface GetStocksQuotes200ResponseResultsInner */ -export interface SnapshotOHLCVVWOtc { +export interface GetStocksQuotes200ResponseResultsInner { /** - * The close price for the symbol in the given time period. + * The ask exchange ID * @type {number} - * @memberof SnapshotOHLCVVWOtc + * @memberof GetStocksQuotes200ResponseResultsInner */ - 'c': number; + 'ask_exchange'?: number; /** - * The highest price for the symbol in the given time period. + * The ask price. * @type {number} - * @memberof SnapshotOHLCVVWOtc + * @memberof GetStocksQuotes200ResponseResultsInner */ - 'h': number; + 'ask_price'?: number; /** - * The lowest price for the symbol in the given time period. + * The total number of shares available for sale at the current ask price. * @type {number} - * @memberof SnapshotOHLCVVWOtc + * @memberof GetStocksQuotes200ResponseResultsInner */ - 'l': number; + 'ask_size'?: number; /** - * The open price for the symbol in the given time period. + * The bid exchange ID * @type {number} - * @memberof SnapshotOHLCVVWOtc + * @memberof GetStocksQuotes200ResponseResultsInner */ - 'o': number; + 'bid_exchange'?: number; /** - * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. - * @type {boolean} - * @memberof SnapshotOHLCVVWOtc + * The bid price. + * @type {number} + * @memberof GetStocksQuotes200ResponseResultsInner */ - 'otc'?: boolean; + 'bid_price'?: number; /** - * The trading volume of the symbol in the given time period. + * The total number of shares that buyers want to purchase at the current bid price. * @type {number} - * @memberof SnapshotOHLCVVWOtc + * @memberof GetStocksQuotes200ResponseResultsInner */ - 'v': number; + 'bid_size'?: number; /** - * The volume weighted average price. + * A list of condition codes. + * @type {Array} + * @memberof GetStocksQuotes200ResponseResultsInner + */ + 'conditions'?: Array; + /** + * A list of indicator codes. + * @type {Array} + * @memberof GetStocksQuotes200ResponseResultsInner + */ + 'indicators'?: Array; + /** + * The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange. * @type {number} - * @memberof SnapshotOHLCVVWOtc + * @memberof GetStocksQuotes200ResponseResultsInner */ - 'vw': number; -} -/** - * - * @export - * @interface StandardBase - */ -export interface StandardBase { + 'participant_timestamp': number; /** - * A request id assigned by the server. - * @type {string} - * @memberof StandardBase + * The sequence number represents the sequence in which quote events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). Values reset after each trading session/day. + * @type {number} + * @memberof GetStocksQuotes200ResponseResultsInner */ - 'request_id': string; + 'sequence_number': number; /** - * The total number of results for this request. + * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it. * @type {number} - * @memberof StandardBase + * @memberof GetStocksQuotes200ResponseResultsInner */ - 'count'?: number; + 'sip_timestamp': number; /** - * The status of this request\'s response. - * @type {string} - * @memberof StandardBase + * There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C. * Tape A is NYSE listed securities * Tape B is NYSE ARCA / NYSE American * Tape C is NASDAQ + * @type {number} + * @memberof GetStocksQuotes200ResponseResultsInner */ - 'status': string; + 'tape'?: number; + /** + * The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this quote. + * @type {number} + * @memberof GetStocksQuotes200ResponseResultsInner + */ + 'trf_timestamp'?: number; } /** * * @export - * @interface StatusBase + * @interface GetStocksSnapshotDirection200Response */ -export interface StatusBase { +export interface GetStocksSnapshotDirection200Response { /** * The status of this request\'s response. * @type {string} - * @memberof StatusBase + * @memberof GetStocksSnapshotDirection200Response */ 'status': string; + /** + * An array of snapshot data for the specified tickers. + * @type {Array} + * @memberof GetStocksSnapshotDirection200Response + */ + 'tickers'?: Array; } /** * * @export - * @interface StatusCountBase + * @interface GetStocksSnapshotTicker200Response */ -export interface StatusCountBase { - /** - * The total number of results for this request. - * @type {number} - * @memberof StatusCountBase - */ - 'count'?: number; +export interface GetStocksSnapshotTicker200Response { /** * The status of this request\'s response. * @type {string} - * @memberof StatusCountBase + * @memberof GetStocksSnapshotTicker200Response */ 'status': string; -} -/** - * - * @export - * @interface StocksGroupedResults - */ -export interface StocksGroupedResults { /** - * An array of results containing the requested data. - * @type {Array} - * @memberof StocksGroupedResults + * A request id assigned by the server. + * @type {string} + * @memberof GetStocksSnapshotTicker200Response */ - 'results'?: Array; + 'request_id': string; + /** + * + * @type {GetStocksSnapshotTicker200ResponseAllOfTicker} + * @memberof GetStocksSnapshotTicker200Response + */ + 'ticker'?: GetStocksSnapshotTicker200ResponseAllOfTicker; } /** - * + * Contains the requested snapshot data for the specified ticker. * @export - * @interface StocksOpenClose + * @interface GetStocksSnapshotTicker200ResponseAllOfTicker */ -export interface StocksOpenClose { +export interface GetStocksSnapshotTicker200ResponseAllOfTicker { /** - * The close price of the ticker symbol in after hours trading. - * @type {number} - * @memberof StocksOpenClose + * + * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay} + * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker */ - 'afterHours'?: number; + 'day'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay; /** - * The close price for the symbol in the given time period. + * Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us. * @type {number} - * @memberof StocksOpenClose + * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker */ - 'close': number; + 'fmv'?: number; /** - * The requested date. - * @type {string} - * @memberof StocksOpenClose + * + * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote} + * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker */ - 'from': string; + 'lastQuote'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote; /** - * The highest price for the symbol in the given time period. - * @type {number} - * @memberof StocksOpenClose + * + * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade} + * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker */ - 'high': number; + 'lastTrade'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade; /** - * The lowest price for the symbol in the given time period. + * + * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin} + * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker + */ + 'min'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin; + /** + * + * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay} + * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker + */ + 'prevDay'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay; + /** + * The exchange symbol that this item is traded under. + * @type {string} + * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker + */ + 'ticker'?: string; + /** + * The value of the change from the previous day. * @type {number} - * @memberof StocksOpenClose + * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker */ - 'low': number; + 'todaysChange'?: number; /** - * The open price for the symbol in the given time period. + * The percentage change since the previous day. * @type {number} - * @memberof StocksOpenClose + * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker */ - 'open': number; + 'todaysChangePerc'?: number; /** - * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. - * @type {boolean} - * @memberof StocksOpenClose + * The last updated timestamp. + * @type {number} + * @memberof GetStocksSnapshotTicker200ResponseAllOfTicker */ - 'otc'?: boolean; + 'updated'?: number; +} +/** + * + * @export + * @interface GetStocksSnapshotTickers200Response + */ +export interface GetStocksSnapshotTickers200Response { /** - * The open price of the ticker symbol in pre-market trading. + * The total number of results for this request. * @type {number} - * @memberof StocksOpenClose + * @memberof GetStocksSnapshotTickers200Response */ - 'preMarket'?: number; + 'count'?: number; /** * The status of this request\'s response. * @type {string} - * @memberof StocksOpenClose + * @memberof GetStocksSnapshotTickers200Response */ 'status': string; /** - * The exchange symbol that this item is traded under. - * @type {string} - * @memberof StocksOpenClose - */ - 'symbol': string; - /** - * The trading volume of the symbol in the given time period. - * @type {number} - * @memberof StocksOpenClose + * An array of snapshot data for the specified tickers. + * @type {Array} + * @memberof GetStocksSnapshotTickers200Response */ - 'volume': number; + 'tickers'?: Array; } /** * * @export - * @interface StocksSnapshotLastQuote + * @interface GetStocksSnapshotTickers200ResponseAllOfTickersInner */ -export interface StocksSnapshotLastQuote { +export interface GetStocksSnapshotTickers200ResponseAllOfTickersInner { /** - * The ask price. - * @type {number} - * @memberof StocksSnapshotLastQuote + * + * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay} + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner */ - 'P': number; + 'day'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay; /** - * The ask size in lots. + * Fair market value is only available on Business plans. It is our proprietary algorithm to generate a real-time, accurate, fair market value of a tradable security. For more information, contact us. * @type {number} - * @memberof StocksSnapshotLastQuote + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner */ - 'S': number; + 'fmv'?: number; /** - * The bid price. + * + * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote} + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner + */ + 'lastQuote'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote; + /** + * + * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade} + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner + */ + 'lastTrade'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade; + /** + * + * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin} + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner + */ + 'min'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin; + /** + * + * @type {GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay} + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner + */ + 'prevDay'?: GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay; + /** + * The exchange symbol that this item is traded under. + * @type {string} + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner + */ + 'ticker'?: string; + /** + * The value of the change from the previous day. * @type {number} - * @memberof StocksSnapshotLastQuote + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner */ - 'p': number; + 'todaysChange'?: number; /** - * The bid size in lots. + * The percentage change since the previous day. * @type {number} - * @memberof StocksSnapshotLastQuote + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner */ - 's': number; + 'todaysChangePerc'?: number; /** - * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. + * The last updated timestamp. * @type {number} - * @memberof StocksSnapshotLastQuote + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInner */ - 't': number; + 'updated'?: number; } /** - * + * The most recent daily bar for this ticker. * @export - * @interface StocksSnapshotMinute + * @interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay */ -export interface StocksSnapshotMinute { - /** - * The accumulated volume. - * @type {number} - * @memberof StocksSnapshotMinute - */ - 'av': number; +export interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay { /** * The close price for the symbol in the given time period. * @type {number} - * @memberof StocksSnapshotMinute + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay */ 'c': number; /** * The highest price for the symbol in the given time period. * @type {number} - * @memberof StocksSnapshotMinute + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay */ 'h': number; /** * The lowest price for the symbol in the given time period. * @type {number} - * @memberof StocksSnapshotMinute + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay */ 'l': number; - /** - * The number of transactions in the aggregate window. - * @type {number} - * @memberof StocksSnapshotMinute - */ - 'n': number; /** * The open price for the symbol in the given time period. * @type {number} - * @memberof StocksSnapshotMinute + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay */ 'o': number; /** - * The Unix millisecond timestamp for the start of the aggregate window. - * @type {number} - * @memberof StocksSnapshotMinute + * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. + * @type {boolean} + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay */ - 't': number; + 'otc'?: boolean; /** * The trading volume of the symbol in the given time period. * @type {number} - * @memberof StocksSnapshotMinute + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay */ 'v': number; /** * The volume weighted average price. * @type {number} - * @memberof StocksSnapshotMinute + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerDay */ 'vw': number; } /** - * + * The most recent quote for this ticker. This is only returned if your current plan includes quotes. * @export - * @interface StocksSnapshotMinuteOTC + * @interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote */ -export interface StocksSnapshotMinuteOTC { +export interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote { /** - * The accumulated volume. + * The ask price. * @type {number} - * @memberof StocksSnapshotMinuteOTC + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote */ - 'av': number; + 'P': number; /** - * The close price for the symbol in the given time period. + * The ask size in lots. * @type {number} - * @memberof StocksSnapshotMinuteOTC + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote */ - 'c': number; + 'S': number; /** - * The highest price for the symbol in the given time period. + * The bid price. * @type {number} - * @memberof StocksSnapshotMinuteOTC + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote */ - 'h': number; + 'p': number; /** - * The lowest price for the symbol in the given time period. + * The bid size in lots. * @type {number} - * @memberof StocksSnapshotMinuteOTC + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote */ - 'l': number; + 's': number; /** - * The number of transactions in the aggregate window. + * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. * @type {number} - * @memberof StocksSnapshotMinuteOTC + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastQuote */ - 'n': number; + 't': number; +} +/** + * The most recent trade for this ticker. This is only returned if your current plan includes trades. + * @export + * @interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade + */ +export interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade { /** - * The open price for the symbol in the given time period. - * @type {number} - * @memberof StocksSnapshotMinuteOTC + * The trade conditions. + * @type {Array} + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade */ - 'o': number; + 'c': Array; /** - * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. - * @type {boolean} - * @memberof StocksSnapshotMinuteOTC + * The Trade ID which uniquely identifies a trade. These are unique per combination of ticker, exchange, and TRF. For example: A trade for AAPL executed on NYSE and a trade for AAPL executed on NASDAQ could potentially have the same Trade ID. + * @type {string} + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade */ - 'otc'?: boolean; + 'i': string; /** - * The Unix millisecond timestamp for the start of the aggregate window. + * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. * @type {number} - * @memberof StocksSnapshotMinuteOTC + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade */ - 't': number; + 'p': number; /** - * The trading volume of the symbol in the given time period. + * The size (volume) of the trade. * @type {number} - * @memberof StocksSnapshotMinuteOTC + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade */ - 'v': number; + 's': number; /** - * The volume weighted average price. + * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. * @type {number} - * @memberof StocksSnapshotMinuteOTC + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade */ - 'vw': number; + 't': number; + /** + * The exchange ID. See Exchanges for Massive.com\'s mapping of exchange IDs. + * @type {number} + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerLastTrade + */ + 'x': number; } /** - * + * The most recent minute bar for this ticker. * @export - * @interface StocksSnapshotTicker + * @interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin */ -export interface StocksSnapshotTicker { - /** - * - * @type {GetStocksSnapshotTicker200ResponseAllOfTicker} - * @memberof StocksSnapshotTicker - */ - 'ticker'?: GetStocksSnapshotTicker200ResponseAllOfTicker; -} -/** - * - * @export - * @interface StocksSnapshotTickers - */ -export interface StocksSnapshotTickers { - /** - * An array of snapshot data for the specified tickers. - * @type {Array} - * @memberof StocksSnapshotTickers - */ - 'tickers'?: Array; -} -/** - * - * @export - * @interface StocksTickerResultsOTC - */ -export interface StocksTickerResultsOTC { - /** - * An array of results containing the requested data. - * @type {Array} - * @memberof StocksTickerResultsOTC - */ - 'results'?: Array; -} -/** - * - * @export - * @interface StocksV2Base - */ -export interface StocksV2Base { - /** - * The exchange symbol that this item is traded under. - * @type {string} - * @memberof StocksV2Base - */ - 'T': string; +export interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin { /** - * The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message. + * The accumulated volume. * @type {number} - * @memberof StocksV2Base + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin */ - 'f': number; + 'av': number; /** - * The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). + * The close price for the symbol in the given time period. * @type {number} - * @memberof StocksV2Base + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin */ - 'q': number; + 'c': number; /** - * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. + * The highest price for the symbol in the given time period. * @type {number} - * @memberof StocksV2Base + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin */ - 't': number; + 'h': number; /** - * The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange. + * The lowest price for the symbol in the given time period. * @type {number} - * @memberof StocksV2Base + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin */ - 'y': number; -} -/** - * - * @export - * @interface StocksV2NBBO - */ -export interface StocksV2NBBO { + 'l': number; /** - * The exchange symbol that this item is traded under. - * @type {string} - * @memberof StocksV2NBBO + * The number of transactions in the aggregate window. + * @type {number} + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin */ - 'T': string; + 'n': number; /** - * The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message. + * The open price for the symbol in the given time period. * @type {number} - * @memberof StocksV2NBBO + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin */ - 'f': number; + 'o': number; /** - * The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). - * @type {number} - * @memberof StocksV2NBBO + * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. + * @type {boolean} + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin */ - 'q': number; + 'otc'?: boolean; /** - * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. + * The Unix millisecond timestamp for the start of the aggregate window. * @type {number} - * @memberof StocksV2NBBO + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin */ 't': number; /** - * The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange. + * The trading volume of the symbol in the given time period. * @type {number} - * @memberof StocksV2NBBO + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin */ - 'y': number; + 'v': number; /** - * The ask price. + * The volume weighted average price. * @type {number} - * @memberof StocksV2NBBO + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerMin */ - 'P': number; + 'vw': number; +} +/** + * The previous day\'s bar for this ticker. + * @export + * @interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay + */ +export interface GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay { /** - * The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price. + * The close price for the symbol in the given time period. * @type {number} - * @memberof StocksV2NBBO + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay */ - 'S': number; + 'c': number; /** - * The ask exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. + * The highest price for the symbol in the given time period. * @type {number} - * @memberof StocksV2NBBO - */ - 'X': number; - /** - * A list of condition codes. - * @type {Array} - * @memberof StocksV2NBBO + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay */ - 'c': Array; + 'h': number; /** - * The indicators. For more information, see our glossary of [Conditions and Indicators](https://polygon.io/glossary/us/stocks/conditions-indicators). - * @type {Array} - * @memberof StocksV2NBBO + * The lowest price for the symbol in the given time period. + * @type {number} + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay */ - 'i': Array; + 'l': number; /** - * The bid price. + * The open price for the symbol in the given time period. * @type {number} - * @memberof StocksV2NBBO + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay */ - 'p': number; + 'o': number; /** - * The bid size. This represents the number of round lot orders at the given bid price. The normal round lot size is 100 shares. A bid size of 2 means there are 200 shares for purchase at the given bid price. - * @type {number} - * @memberof StocksV2NBBO + * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. + * @type {boolean} + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay */ - 's': number; + 'otc'?: boolean; /** - * The bid exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. + * The trading volume of the symbol in the given time period. * @type {number} - * @memberof StocksV2NBBO + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay */ - 'x': number; + 'v': number; /** - * There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C. * Tape A is NYSE listed securities * Tape B is NYSE ARCA / NYSE American * Tape C is NASDAQ + * The volume weighted average price. * @type {number} - * @memberof StocksV2NBBO + * @memberof GetStocksSnapshotTickers200ResponseAllOfTickersInnerPrevDay */ - 'z': number; + 'vw': number; } /** * * @export - * @interface StocksV2NBBOs + * @interface GetStocksTrades200Response */ -export interface StocksV2NBBOs { +export interface GetStocksTrades200Response { /** - * - * @type {Array} - * @memberof StocksV2NBBOs + * If present, this value can be used to fetch the next page of data. + * @type {string} + * @memberof GetStocksTrades200Response */ - 'results'?: Array; + 'next_url'?: string; + /** + * A request id assigned by the server. + * @type {string} + * @memberof GetStocksTrades200Response + */ + 'request_id'?: string; + /** + * An array of results containing the requested data. + * @type {Array} + * @memberof GetStocksTrades200Response + */ + 'results'?: Array; + /** + * The status of this request\'s response. + * @type {string} + * @memberof GetStocksTrades200Response + */ + 'status': string; } /** * * @export - * @interface StocksV2Trade + * @interface GetStocksTrades200ResponseResultsInner */ -export interface StocksV2Trade { +export interface GetStocksTrades200ResponseResultsInner { /** - * The exchange symbol that this item is traded under. - * @type {string} - * @memberof StocksV2Trade + * A list of condition codes. + * @type {Array} + * @memberof GetStocksTrades200ResponseResultsInner */ - 'T': string; + 'conditions'?: Array; /** - * The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message. + * The trade correction indicator. * @type {number} - * @memberof StocksV2Trade + * @memberof GetStocksTrades200ResponseResultsInner */ - 'f': number; + 'correction'?: number; /** - * The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). + * The exchange ID. See Exchanges for Massive.com\'s mapping of exchange IDs. * @type {number} - * @memberof StocksV2Trade + * @memberof GetStocksTrades200ResponseResultsInner */ - 'q': number; + 'exchange': number; /** - * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. + * The Trade ID which uniquely identifies a trade. These are unique per combination of ticker, exchange, and TRF. For example: A trade for AAPL executed on NYSE and a trade for AAPL executed on NASDAQ could potentially have the same Trade ID. + * @type {string} + * @memberof GetStocksTrades200ResponseResultsInner + */ + 'id': string; + /** + * The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the trade was actually generated at the exchange. * @type {number} - * @memberof StocksV2Trade + * @memberof GetStocksTrades200ResponseResultsInner */ - 't': number; + 'participant_timestamp': number; /** - * The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange. + * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. * @type {number} - * @memberof StocksV2Trade + * @memberof GetStocksTrades200ResponseResultsInner */ - 'y': number; + 'price': number; /** - * A list of condition codes. - * @type {Array} - * @memberof StocksV2Trade + * The sequence number represents the sequence in which trade events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). Values reset after each trading session/day. + * @type {number} + * @memberof GetStocksTrades200ResponseResultsInner */ - 'c': Array; + 'sequence_number': number; /** - * The trade correction indicator. + * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this trade from the exchange which produced it. * @type {number} - * @memberof StocksV2Trade + * @memberof GetStocksTrades200ResponseResultsInner */ - 'e': number; + 'sip_timestamp': number; /** - * The Trade ID which uniquely identifies a trade. These are unique per combination of ticker, exchange, and TRF. For example: A trade for AAPL executed on NYSE and a trade for AAPL executed on NASDAQ could potentially have the same Trade ID. - * @type {string} - * @memberof StocksV2Trade - */ - 'i': string; - /** - * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. - * @type {number} - * @memberof StocksV2Trade - */ - 'p': number; - /** - * The ID for the Trade Reporting Facility where the trade took place. + * The size of a trade (also known as volume). * @type {number} - * @memberof StocksV2Trade + * @memberof GetStocksTrades200ResponseResultsInner */ - 'r': number; + 'size': number; /** - * The size of a trade (also known as volume). + * There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C. * Tape A is NYSE listed securities * Tape B is NYSE ARCA / NYSE American * Tape C is NASDAQ * @type {number} - * @memberof StocksV2Trade + * @memberof GetStocksTrades200ResponseResultsInner */ - 's': number; + 'tape'?: number; /** - * The exchange ID. See Exchanges for Polygon.io\'s mapping of exchange IDs. + * The ID for the Trade Reporting Facility where the trade took place. * @type {number} - * @memberof StocksV2Trade + * @memberof GetStocksTrades200ResponseResultsInner */ - 'x': number; + 'trf_id'?: number; /** - * There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C. * Tape A is NYSE listed securities * Tape B is NYSE ARCA / NYSE American * Tape C is NASDAQ + * The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this trade. * @type {number} - * @memberof StocksV2Trade + * @memberof GetStocksTrades200ResponseResultsInner */ - 'z': number; + 'trf_timestamp'?: number; } /** * * @export - * @interface StocksV2Trades + * @interface GetStocksV1Exchanges200Response */ -export interface StocksV2Trades { +export interface GetStocksV1Exchanges200Response { /** - * - * @type {Array} - * @memberof StocksV2Trades + * If present, this value can be used to fetch the next page. + * @type {string} + * @memberof GetStocksV1Exchanges200Response */ - 'results'?: Array; -} -/** - * - * @export - * @interface TickerBase - */ -export interface TickerBase { + 'next_url'?: string; /** - * The exchange symbol that this item is traded under. + * A request id assigned by the server. * @type {string} - * @memberof TickerBase + * @memberof GetStocksV1Exchanges200Response */ - 'ticker': string; -} -/** - * - * @export - * @interface TickerResults - */ -export interface TickerResults { + 'request_id': string; /** - * An array of results containing the requested data. - * @type {Array} - * @memberof TickerResults + * The results for this request. + * @type {Array} + * @memberof GetStocksV1Exchanges200Response */ - 'results'?: Array; + 'results': Array; + /** + * The status of this request\'s response. + * @type {string} + * @memberof GetStocksV1Exchanges200Response + */ + 'status': GetStocksV1Exchanges200ResponseStatusEnum; } + +/** + * @export + * @enum {string} + */ +export enum GetStocksV1Exchanges200ResponseStatusEnum { + Ok = 'OK' +} + /** * * @export - * @interface TradeDetailsMapItem + * @interface GetStocksV1Exchanges200ResponseResultsInner */ -export interface TradeDetailsMapItem { +export interface GetStocksV1Exchanges200ResponseResultsInner { /** - * Name of the trade detail item + * Short acronym or abbreviation (may be null for some venues). * @type {string} - * @memberof TradeDetailsMapItem + * @memberof GetStocksV1Exchanges200ResponseResultsInner */ - 'name'?: string; + 'acronym'?: string; /** - * Actual type of the trade detail item + * Numeric identifier for the trading venue or exchange. * @type {string} - * @memberof TradeDetailsMapItem + * @memberof GetStocksV1Exchanges200ResponseResultsInner */ - 'type'?: string; + 'id': string; + /** + * Geographic location code. + * @type {string} + * @memberof GetStocksV1Exchanges200ResponseResultsInner + */ + 'locale'?: string; + /** + * Market Identifier Code (MIC) - ISO 10383 standard four-character code for the market (may be empty for some venues). + * @type {string} + * @memberof GetStocksV1Exchanges200ResponseResultsInner + */ + 'mic'?: string; + /** + * Full official name of the exchange, trading venue, or reporting facility. + * @type {string} + * @memberof GetStocksV1Exchanges200ResponseResultsInner + */ + 'name': string; + /** + * Operating Market Identifier Code - identifies the specific operating entity or parent organization. + * @type {string} + * @memberof GetStocksV1Exchanges200ResponseResultsInner + */ + 'operating_mic'?: string; + /** + * Single-character participant identifier used in market data feeds and trade reporting. + * @type {string} + * @memberof GetStocksV1Exchanges200ResponseResultsInner + */ + 'participant_id'?: string; + /** + * Type of trading venue: \'exchange\' for stock exchanges, \'TRF\' for Trade Reporting Facilities, \'SIP\' for Securities Information Processors, \'ORF\' for OTC Reporting Facility. + * @type {string} + * @memberof GetStocksV1Exchanges200ResponseResultsInner + */ + 'type': string; + /** + * Official website URL of the organization operating the venue. + * @type {string} + * @memberof GetStocksV1Exchanges200ResponseResultsInner + */ + 'url'?: string; } /** * * @export - * @interface V1LastBase + * @interface GetStocksV1ShortInterest200Response */ -export interface V1LastBase { +export interface GetStocksV1ShortInterest200Response { + /** + * If present, this value can be used to fetch the next page. + * @type {string} + * @memberof GetStocksV1ShortInterest200Response + */ + 'next_url'?: string; /** * A request id assigned by the server. * @type {string} - * @memberof V1LastBase + * @memberof GetStocksV1ShortInterest200Response */ 'request_id': string; /** - * The status of this request\'s response. - * @type {string} - * @memberof V1LastBase + * The results for this request. + * @type {Array} + * @memberof GetStocksV1ShortInterest200Response */ - 'status': string; + 'results': Array; /** - * The exchange symbol that this item is traded under. + * The status of this request\'s response. * @type {string} - * @memberof V1LastBase + * @memberof GetStocksV1ShortInterest200Response */ - 'symbol': string; + 'status': GetStocksV1ShortInterest200ResponseStatusEnum; } + +/** + * @export + * @enum {string} + */ +export enum GetStocksV1ShortInterest200ResponseStatusEnum { + Ok = 'OK' +} + /** * * @export - * @interface V2AggsBase + * @interface GetStocksV1ShortInterest200ResponseResultsInner */ -export interface V2AggsBase { +export interface GetStocksV1ShortInterest200ResponseResultsInner { /** - * Whether or not this response was adjusted for splits. - * @type {boolean} - * @memberof V2AggsBase + * The average daily trading volume for the stock over a specified period, typically used to contextualize short interest. + * @type {number} + * @memberof GetStocksV1ShortInterest200ResponseResultsInner */ - 'adjusted': boolean; + 'avg_daily_volume': number; /** - * The number of aggregates (minute or day) used to generate the response. + * Calculated as short_interest divided by avg_daily_volume, representing the estimated number of days it would take to cover all short positions based on average trading volume. * @type {number} - * @memberof V2AggsBase + * @memberof GetStocksV1ShortInterest200ResponseResultsInner */ - 'queryCount': number; + 'days_to_cover': number; /** - * A request id assigned by the server. + * The date (formatted as YYYY-MM-DD) on which the short interest data is considered settled, typically based on exchange reporting schedules. * @type {string} - * @memberof V2AggsBase + * @memberof GetStocksV1ShortInterest200ResponseResultsInner */ - 'request_id': string; + 'settlement_date': string; /** - * The total number of results for this request. + * The total number of shares that have been sold short but have not yet been covered or closed out. * @type {number} - * @memberof V2AggsBase + * @memberof GetStocksV1ShortInterest200ResponseResultsInner */ - 'resultsCount': number; + 'short_interest'?: number; /** - * The status of this request\'s response. + * The primary ticker symbol for the stock. * @type {string} - * @memberof V2AggsBase + * @memberof GetStocksV1ShortInterest200ResponseResultsInner */ - 'status': string; + 'ticker'?: string; } /** * * @export - * @interface V2LastBase + * @interface GetStocksV1ShortVolume200Response */ -export interface V2LastBase { +export interface GetStocksV1ShortVolume200Response { + /** + * If present, this value can be used to fetch the next page. + * @type {string} + * @memberof GetStocksV1ShortVolume200Response + */ + 'next_url'?: string; /** * A request id assigned by the server. * @type {string} - * @memberof V2LastBase + * @memberof GetStocksV1ShortVolume200Response */ 'request_id': string; + /** + * The results for this request. + * @type {Array} + * @memberof GetStocksV1ShortVolume200Response + */ + 'results': Array; /** * The status of this request\'s response. * @type {string} - * @memberof V2LastBase + * @memberof GetStocksV1ShortVolume200Response */ - 'status': string; + 'status': GetStocksV1ShortVolume200ResponseStatusEnum; +} + +/** + * @export + * @enum {string} + */ +export enum GetStocksV1ShortVolume200ResponseStatusEnum { + Ok = 'OK' } + /** * * @export - * @interface V2TicksBase + * @interface GetStocksV1ShortVolume200ResponseResultsInner */ -export interface V2TicksBase { +export interface GetStocksV1ShortVolume200ResponseResultsInner { /** - * Latency in milliseconds for the query results from the database. + * Short volume reported via the Alternative Display Facility (ADF), excluding exempt volume. * @type {number} - * @memberof V2TicksBase + * @memberof GetStocksV1ShortVolume200ResponseResultsInner */ - 'db_latency'?: number; + 'adf_short_volume'?: number; /** - * The total number of results for this request. + * Short volume reported via ADF that was marked as exempt. * @type {number} - * @memberof V2TicksBase + * @memberof GetStocksV1ShortVolume200ResponseResultsInner */ - 'results_count'?: number; + 'adf_short_volume_exempt'?: number; /** - * Whether or not this query was executed successfully. - * @type {boolean} - * @memberof V2TicksBase + * The date of trade activity reported in the format YYYY-MM-DD + * @type {string} + * @memberof GetStocksV1ShortVolume200ResponseResultsInner */ - 'success'?: boolean; + 'date': string; /** - * The exchange symbol that this item is traded under. - * @type {string} - * @memberof V2TicksBase + * Portion of short volume that was marked as exempt from regulation SHO. + * @type {number} + * @memberof GetStocksV1ShortVolume200ResponseResultsInner */ - 'ticker'?: string; -} - -/** - * DefaultApi - axios parameter creator - * @export + 'exempt_volume'?: number; + /** + * Short volume reported from Nasdaq\'s Carteret facility, excluding exempt volume. + * @type {number} + * @memberof GetStocksV1ShortVolume200ResponseResultsInner + */ + 'nasdaq_carteret_short_volume'?: number; + /** + * Short volume from Nasdaq Carteret that was marked as exempt. + * @type {number} + * @memberof GetStocksV1ShortVolume200ResponseResultsInner + */ + 'nasdaq_carteret_short_volume_exempt'?: number; + /** + * Short volume reported from Nasdaq\'s Chicago facility, excluding exempt volume. + * @type {number} + * @memberof GetStocksV1ShortVolume200ResponseResultsInner + */ + 'nasdaq_chicago_short_volume'?: number; + /** + * Short volume from Nasdaq Chicago that was marked as exempt. + * @type {number} + * @memberof GetStocksV1ShortVolume200ResponseResultsInner + */ + 'nasdaq_chicago_short_volume_exempt'?: number; + /** + * Portion of short volume that was not exempt from regulation SHO (i.e., short_volume - exempt_volume). + * @type {number} + * @memberof GetStocksV1ShortVolume200ResponseResultsInner + */ + 'non_exempt_volume'?: number; + /** + * Short volume reported from NYSE facilities, excluding exempt volume. + * @type {number} + * @memberof GetStocksV1ShortVolume200ResponseResultsInner + */ + 'nyse_short_volume'?: number; + /** + * Short volume from NYSE facilities that was marked as exempt. + * @type {number} + * @memberof GetStocksV1ShortVolume200ResponseResultsInner + */ + 'nyse_short_volume_exempt'?: number; + /** + * Total number of shares sold short across all venues for the ticker on the given date. + * @type {number} + * @memberof GetStocksV1ShortVolume200ResponseResultsInner + */ + 'short_volume'?: number; + /** + * The percentage of total volume that was sold short. Calculated as (short_volume / total_volume) * 100. + * @type {number} + * @memberof GetStocksV1ShortVolume200ResponseResultsInner + */ + 'short_volume_ratio'?: number; + /** + * The primary ticker symbol for the stock. + * @type {string} + * @memberof GetStocksV1ShortVolume200ResponseResultsInner + */ + 'ticker'?: string; + /** + * Total reported volume across all venues for the ticker on the given date. + * @type {number} + * @memberof GetStocksV1ShortVolume200ResponseResultsInner + */ + 'total_volume'?: number; +} +/** + * + * @export + * @interface GetTicker200Response */ -export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) { - return { +export interface GetTicker200Response { + /** + * The total number of results for this request. + * @type {number} + * @memberof GetTicker200Response + */ + 'count'?: number; + /** + * A request id assigned by the server. + * @type {string} + * @memberof GetTicker200Response + */ + 'request_id'?: string; + /** + * + * @type {GetTicker200ResponseResults} + * @memberof GetTicker200Response + */ + 'results'?: GetTicker200ResponseResults; + /** + * The status of this request\'s response. + * @type {string} + * @memberof GetTicker200Response + */ + 'status'?: string; +} +/** + * Ticker with details. + * @export + * @interface GetTicker200ResponseResults + */ +export interface GetTicker200ResponseResults { + /** + * Whether or not the asset is actively traded. False means the asset has been delisted. + * @type {boolean} + * @memberof GetTicker200ResponseResults + */ + 'active': boolean; + /** + * + * @type {GetTicker200ResponseResultsAddress} + * @memberof GetTicker200ResponseResults + */ + 'address'?: GetTicker200ResponseResultsAddress; + /** + * + * @type {GetTicker200ResponseResultsBranding} + * @memberof GetTicker200ResponseResults + */ + 'branding'?: GetTicker200ResponseResultsBranding; + /** + * The CIK number for this ticker. Find more information [here](https://en.wikipedia.org/wiki/Central_Index_Key). + * @type {string} + * @memberof GetTicker200ResponseResults + */ + 'cik'?: string; + /** + * The composite OpenFIGI number for this ticker. Find more information [here](https://www.openfigi.com/about/figi) + * @type {string} + * @memberof GetTicker200ResponseResults + */ + 'composite_figi'?: string; + /** + * The name of the currency that this asset is traded with. + * @type {string} + * @memberof GetTicker200ResponseResults + */ + 'currency_name': string; + /** + * The last date that the asset was traded. + * @type {string} + * @memberof GetTicker200ResponseResults + */ + 'delisted_utc'?: string; + /** + * A description of the company and what they do/offer. + * @type {string} + * @memberof GetTicker200ResponseResults + */ + 'description'?: string; + /** + * The URL of the company\'s website homepage. + * @type {string} + * @memberof GetTicker200ResponseResults + */ + 'homepage_url'?: string; + /** + * The date that the symbol was first publicly listed in the format YYYY-MM-DD. + * @type {string} + * @memberof GetTicker200ResponseResults + */ + 'list_date'?: string; + /** + * The locale of the asset. + * @type {string} + * @memberof GetTicker200ResponseResults + */ + 'locale': GetTicker200ResponseResultsLocaleEnum; + /** + * The market type of the asset. + * @type {string} + * @memberof GetTicker200ResponseResults + */ + 'market': GetTicker200ResponseResultsMarketEnum; + /** + * The most recent close price of the ticker multiplied by weighted outstanding shares. + * @type {number} + * @memberof GetTicker200ResponseResults + */ + 'market_cap'?: number; + /** + * The name of the asset. For stocks/equities this will be the companies registered name. For crypto/fx this will be the name of the currency or coin pair. + * @type {string} + * @memberof GetTicker200ResponseResults + */ + 'name': string; + /** + * The phone number for the company behind this ticker. + * @type {string} + * @memberof GetTicker200ResponseResults + */ + 'phone_number'?: string; + /** + * The ISO code of the primary listing exchange for this asset. + * @type {string} + * @memberof GetTicker200ResponseResults + */ + 'primary_exchange'?: string; + /** + * Round lot size of this security. + * @type {number} + * @memberof GetTicker200ResponseResults + */ + 'round_lot'?: number; + /** + * The share Class OpenFIGI number for this ticker. Find more information [here](https://www.openfigi.com/about/figi) + * @type {string} + * @memberof GetTicker200ResponseResults + */ + 'share_class_figi'?: string; + /** + * The recorded number of outstanding shares for this particular share class. + * @type {number} + * @memberof GetTicker200ResponseResults + */ + 'share_class_shares_outstanding'?: number; + /** + * The standard industrial classification code for this ticker. For a list of SIC Codes, see the SEC\'s SIC Code List. + * @type {string} + * @memberof GetTicker200ResponseResults + */ + 'sic_code'?: string; + /** + * A description of this ticker\'s SIC code. + * @type {string} + * @memberof GetTicker200ResponseResults + */ + 'sic_description'?: string; + /** + * The exchange symbol that this item is traded under. + * @type {string} + * @memberof GetTicker200ResponseResults + */ + 'ticker': string; + /** + * The root of a specified ticker. For example, the root of BRK.A is BRK. + * @type {string} + * @memberof GetTicker200ResponseResults + */ + 'ticker_root'?: string; + /** + * The suffix of a specified ticker. For example, the suffix of BRK.A is A. + * @type {string} + * @memberof GetTicker200ResponseResults + */ + 'ticker_suffix'?: string; + /** + * The approximate number of employees for the company. + * @type {number} + * @memberof GetTicker200ResponseResults + */ + 'total_employees'?: number; + /** + * The type of the asset. Find the types that we support via our [Ticker Types API](https://massive.com/docs/stocks/get_v3_reference_tickers_types). + * @type {string} + * @memberof GetTicker200ResponseResults + */ + 'type'?: string; + /** + * The shares outstanding calculated assuming all shares of other share classes are converted to this share class. + * @type {number} + * @memberof GetTicker200ResponseResults + */ + 'weighted_shares_outstanding'?: number; +} + +/** + * @export + * @enum {string} + */ +export enum GetTicker200ResponseResultsLocaleEnum { + Us = 'us', + Global = 'global' +} +/** + * @export + * @enum {string} + */ +export enum GetTicker200ResponseResultsMarketEnum { + Stocks = 'stocks', + Crypto = 'crypto', + Fx = 'fx', + Otc = 'otc', + Indices = 'indices' +} + +/** + * Company headquarters address details. + * @export + * @interface GetTicker200ResponseResultsAddress + */ +export interface GetTicker200ResponseResultsAddress { + /** + * The first line of the company\'s headquarters address. + * @type {string} + * @memberof GetTicker200ResponseResultsAddress + */ + 'address1'?: string; + /** + * The second line of the company\'s headquarters address, if applicable. + * @type {string} + * @memberof GetTicker200ResponseResultsAddress + */ + 'address2'?: string; + /** + * The city of the company\'s headquarters address. + * @type {string} + * @memberof GetTicker200ResponseResultsAddress + */ + 'city'?: string; + /** + * The postal code of the company\'s headquarters address. + * @type {string} + * @memberof GetTicker200ResponseResultsAddress + */ + 'postal_code'?: string; + /** + * The state of the company\'s headquarters address. + * @type {string} + * @memberof GetTicker200ResponseResultsAddress + */ + 'state'?: string; +} +/** + * Provides URLs aiding in visual identification. + * @export + * @interface GetTicker200ResponseResultsBranding + */ +export interface GetTicker200ResponseResultsBranding { + /** + * A link to this ticker\'s company\'s icon. Icon\'s are generally smaller, square images that represent the company at a glance. Note that you must provide an API key when accessing this URL. See the \"Authentication\" section at the top of this page for more details. + * @type {string} + * @memberof GetTicker200ResponseResultsBranding + */ + 'icon_url'?: string; + /** + * A link to this ticker\'s company\'s logo. Note that you must provide an API key when accessing this URL. See the \"Authentication\" section at the top of this page for more details. + * @type {string} + * @memberof GetTicker200ResponseResultsBranding + */ + 'logo_url'?: string; +} +/** + * + * @export + * @interface GetTmxV1CorporateEvents200Response + */ +export interface GetTmxV1CorporateEvents200Response { + /** + * If present, this value can be used to fetch the next page. + * @type {string} + * @memberof GetTmxV1CorporateEvents200Response + */ + 'next_url'?: string; + /** + * A request id assigned by the server. + * @type {string} + * @memberof GetTmxV1CorporateEvents200Response + */ + 'request_id': string; + /** + * The results for this request. + * @type {Array} + * @memberof GetTmxV1CorporateEvents200Response + */ + 'results': Array; + /** + * The status of this request\'s response. + * @type {string} + * @memberof GetTmxV1CorporateEvents200Response + */ + 'status': GetTmxV1CorporateEvents200ResponseStatusEnum; +} + +/** + * @export + * @enum {string} + */ +export enum GetTmxV1CorporateEvents200ResponseStatusEnum { + Ok = 'OK' +} + +/** + * + * @export + * @interface GetTmxV1CorporateEvents200ResponseResultsInner + */ +export interface GetTmxV1CorporateEvents200ResponseResultsInner { + /** + * Full name of the company. + * @type {string} + * @memberof GetTmxV1CorporateEvents200ResponseResultsInner + */ + 'company_name'?: string; + /** + * Scheduled date of the corporate event, formatted as YYYY-MM-DD. + * @type {string} + * @memberof GetTmxV1CorporateEvents200ResponseResultsInner + */ + 'date'?: string; + /** + * Standard international identifier for the company\'s common stock. + * @type {string} + * @memberof GetTmxV1CorporateEvents200ResponseResultsInner + */ + 'isin'?: string; + /** + * Name or title of the event. + * @type {string} + * @memberof GetTmxV1CorporateEvents200ResponseResultsInner + */ + 'name'?: string; + /** + * The current status of the event. Possible values include: approved, canceled, confirmed, historical, pending_approval, postponed, and unconfirmed. + * @type {string} + * @memberof GetTmxV1CorporateEvents200ResponseResultsInner + */ + 'status'?: string; + /** + * The company\'s stock symbol. + * @type {string} + * @memberof GetTmxV1CorporateEvents200ResponseResultsInner + */ + 'ticker'?: string; + /** + * Unique numeric identifier for the company used by TMX. + * @type {number} + * @memberof GetTmxV1CorporateEvents200ResponseResultsInner + */ + 'tmx_company_id'?: number; + /** + * The unique alphanumeric identifier for the event record used by TMX. + * @type {string} + * @memberof GetTmxV1CorporateEvents200ResponseResultsInner + */ + 'tmx_record_id'?: string; + /** + * MIC (Market Identifier Code) of the exchange where the company\'s stock is listed. + * @type {string} + * @memberof GetTmxV1CorporateEvents200ResponseResultsInner + */ + 'trading_venue'?: string; + /** + * The normalized type of corporate event. Possible values include: analyst_day, business_update, capital_markets_day, conference, dividend, earnings_announcement_date, earnings_conference_call, earnings_results_announcement, forum, interim_statement, other_interim_announcement, production_update, research_and_development_day, seminar, shareholder_meeting, sales_update, stock_split, summit, service_level_update, tradeshow, company_travel, and workshop. + * @type {string} + * @memberof GetTmxV1CorporateEvents200ResponseResultsInner + */ + 'type'?: string; + /** + * URL linking to the primary public source of the event announcement, if available. + * @type {string} + * @memberof GetTmxV1CorporateEvents200ResponseResultsInner + */ + 'url'?: string; +} +/** + * + * @export + * @interface IndexAggsBase + */ +export interface IndexAggsBase { + /** + * The number of aggregates (minute or day) used to generate the response. + * @type {number} + * @memberof IndexAggsBase + */ + 'queryCount': number; + /** + * A request id assigned by the server. + * @type {string} + * @memberof IndexAggsBase + */ + 'request_id': string; + /** + * The total number of results for this request. + * @type {number} + * @memberof IndexAggsBase + */ + 'resultsCount': number; + /** + * The status of this request\'s response. + * @type {string} + * @memberof IndexAggsBase + */ + 'status': string; +} +/** + * + * @export + * @interface IndicesGroupedResults + */ +export interface IndicesGroupedResults { + /** + * An array of results containing the requested data. + * @type {Array} + * @memberof IndicesGroupedResults + */ + 'results'?: Array; +} +/** + * + * @export + * @interface IndicesOpenClose + */ +export interface IndicesOpenClose { + /** + * The close value of the ticker symbol in after hours trading. + * @type {number} + * @memberof IndicesOpenClose + */ + 'afterHours'?: number; + /** + * The close value for the symbol in the given time period. + * @type {number} + * @memberof IndicesOpenClose + */ + 'close': number; + /** + * The requested date. + * @type {string} + * @memberof IndicesOpenClose + */ + 'from': string; + /** + * The highest value for the symbol in the given time period. + * @type {number} + * @memberof IndicesOpenClose + */ + 'high': number; + /** + * The lowest value for the symbol in the given time period. + * @type {number} + * @memberof IndicesOpenClose + */ + 'low': number; + /** + * The open value for the symbol in the given time period. + * @type {number} + * @memberof IndicesOpenClose + */ + 'open': number; + /** + * The open value of the ticker symbol in pre-market trading. + * @type {number} + * @memberof IndicesOpenClose + */ + 'preMarket'?: number; + /** + * The status of this request\'s response. + * @type {string} + * @memberof IndicesOpenClose + */ + 'status': string; + /** + * The exchange symbol that this item is traded under. + * @type {string} + * @memberof IndicesOpenClose + */ + 'symbol': string; +} +/** + * + * @export + * @interface IndicesTickerResults + */ +export interface IndicesTickerResults { + /** + * An array of results containing the requested data. + * @type {Array} + * @memberof IndicesTickerResults + */ + 'results'?: Array; +} +/** + * + * @export + * @interface IndicesTickerResultsResultsInner + */ +export interface IndicesTickerResultsResultsInner { + /** + * The close value for the symbol in the given time period. + * @type {number} + * @memberof IndicesTickerResultsResultsInner + */ + 'c': number; + /** + * The highest value for the symbol in the given time period. + * @type {number} + * @memberof IndicesTickerResultsResultsInner + */ + 'h': number; + /** + * The lowest value for the symbol in the given time period. + * @type {number} + * @memberof IndicesTickerResultsResultsInner + */ + 'l': number; + /** + * The number of transactions in the aggregate window. + * @type {number} + * @memberof IndicesTickerResultsResultsInner + */ + 'n'?: number; + /** + * The open value for the symbol in the given time period. + * @type {number} + * @memberof IndicesTickerResultsResultsInner + */ + 'o': number; + /** + * The Unix millisecond timestamp for the start of the aggregate window. + * @type {number} + * @memberof IndicesTickerResultsResultsInner + */ + 't': number; +} +/** + * + * @export + * @interface ListConditions200Response + */ +export interface ListConditions200Response { + /** + * The total number of results for this request. + * @type {number} + * @memberof ListConditions200Response + */ + 'count': number; + /** + * If present, this value can be used to fetch the next page of data. + * @type {string} + * @memberof ListConditions200Response + */ + 'next_url'?: string; + /** + * A request ID assigned by the server. + * @type {string} + * @memberof ListConditions200Response + */ + 'request_id': string; + /** + * An array of conditions that match your query. + * @type {Array} + * @memberof ListConditions200Response + */ + 'results': Array; + /** + * The status of this request\'s response. + * @type {string} + * @memberof ListConditions200Response + */ + 'status': string; +} +/** + * A condition generally refers to any extra information passed in a trade or a quote. These conditions may or may not affect the behavior of aggregates. + * @export + * @interface ListConditions200ResponseResultsInner + */ +export interface ListConditions200ResponseResultsInner { + /** + * A commonly-used abbreviation for this condition. + * @type {string} + * @memberof ListConditions200ResponseResultsInner + */ + 'abbreviation'?: string; + /** + * An identifier for a group of similar financial instruments. + * @type {string} + * @memberof ListConditions200ResponseResultsInner + */ + 'asset_class': ListConditions200ResponseResultsInnerAssetClassEnum; + /** + * Data types that this condition applies to. + * @type {Array} + * @memberof ListConditions200ResponseResultsInner + */ + 'data_types': Array; + /** + * A short description of the semantics of this condition. + * @type {string} + * @memberof ListConditions200ResponseResultsInner + */ + 'description'?: string; + /** + * If present, mapping this condition from a Massive.com code to a SIP symbol depends on this attribute. In other words, data with this condition attached comes exclusively from the given exchange. + * @type {number} + * @memberof ListConditions200ResponseResultsInner + */ + 'exchange'?: number; + /** + * An identifier used by Massive.com for this condition. Unique per data type. + * @type {number} + * @memberof ListConditions200ResponseResultsInner + */ + 'id': number; + /** + * If true, this condition is from an old version of the SIPs\' specs and no longer is used. Other conditions may or may not reuse the same symbol as this one. + * @type {boolean} + * @memberof ListConditions200ResponseResultsInner + */ + 'legacy'?: boolean; + /** + * The name of this condition. + * @type {string} + * @memberof ListConditions200ResponseResultsInner + */ + 'name': string; + /** + * + * @type {ListConditions200ResponseResultsInnerSipMapping} + * @memberof ListConditions200ResponseResultsInner + */ + 'sip_mapping': ListConditions200ResponseResultsInnerSipMapping; + /** + * An identifier for a collection of related conditions. + * @type {string} + * @memberof ListConditions200ResponseResultsInner + */ + 'type': ListConditions200ResponseResultsInnerTypeEnum; + /** + * + * @type {ListConditions200ResponseResultsInnerUpdateRules} + * @memberof ListConditions200ResponseResultsInner + */ + 'update_rules'?: ListConditions200ResponseResultsInnerUpdateRules; +} + +/** + * @export + * @enum {string} + */ +export enum ListConditions200ResponseResultsInnerAssetClassEnum { + Stocks = 'stocks', + Options = 'options', + Crypto = 'crypto', + Fx = 'fx' +} +/** + * @export + * @enum {string} + */ +export enum ListConditions200ResponseResultsInnerDataTypesEnum { + Trade = 'trade', + Bbo = 'bbo', + Nbbo = 'nbbo' +} +/** + * @export + * @enum {string} + */ +export enum ListConditions200ResponseResultsInnerTypeEnum { + SaleCondition = 'sale_condition', + QuoteCondition = 'quote_condition', + SipGeneratedFlag = 'sip_generated_flag', + FinancialStatusIndicator = 'financial_status_indicator', + ShortSaleRestrictionIndicator = 'short_sale_restriction_indicator', + SettlementCondition = 'settlement_condition', + MarketCondition = 'market_condition', + TradeThruExempt = 'trade_thru_exempt' +} + +/** + * A comprehensive mapping that translates condition codes from individual SIPs (CTA, OPRA, UTP) to a unified code used by Massive.com. This facilitates consistent interpretation and application of market data conditions across different data streams, ensuring that users can accurately apply these conditions to their data analysis and reporting. + * @export + * @interface ListConditions200ResponseResultsInnerSipMapping + */ +export interface ListConditions200ResponseResultsInnerSipMapping { + /** + * Condition code from the Consolidated Tape Association (CTA). + * @type {string} + * @memberof ListConditions200ResponseResultsInnerSipMapping + */ + 'CTA'?: string; + /** + * Condition code from the Options Price Reporting Authority (OPRA). + * @type {string} + * @memberof ListConditions200ResponseResultsInnerSipMapping + */ + 'OPRA'?: string; + /** + * Condition code from UTP Plan (UTP). + * @type {string} + * @memberof ListConditions200ResponseResultsInnerSipMapping + */ + 'UTP'?: string; +} +/** + * A list of aggregation rules. + * @export + * @interface ListConditions200ResponseResultsInnerUpdateRules + */ +export interface ListConditions200ResponseResultsInnerUpdateRules { + /** + * + * @type {ListConditions200ResponseResultsInnerUpdateRulesConsolidated} + * @memberof ListConditions200ResponseResultsInnerUpdateRules + */ + 'consolidated': ListConditions200ResponseResultsInnerUpdateRulesConsolidated; + /** + * + * @type {ListConditions200ResponseResultsInnerUpdateRulesMarketCenter} + * @memberof ListConditions200ResponseResultsInnerUpdateRules + */ + 'market_center': ListConditions200ResponseResultsInnerUpdateRulesMarketCenter; +} +/** + * Describes aggregation rules on a consolidated (all exchanges) basis. + * @export + * @interface ListConditions200ResponseResultsInnerUpdateRulesConsolidated + */ +export interface ListConditions200ResponseResultsInnerUpdateRulesConsolidated { + /** + * Whether or not trades with this condition update the high/low. + * @type {boolean} + * @memberof ListConditions200ResponseResultsInnerUpdateRulesConsolidated + */ + 'updates_high_low': boolean; + /** + * Whether or not trades with this condition update the open/close. + * @type {boolean} + * @memberof ListConditions200ResponseResultsInnerUpdateRulesConsolidated + */ + 'updates_open_close': boolean; + /** + * Whether or not trades with this condition update the volume. + * @type {boolean} + * @memberof ListConditions200ResponseResultsInnerUpdateRulesConsolidated + */ + 'updates_volume': boolean; +} +/** + * Describes aggregation rules on a per-market-center basis. + * @export + * @interface ListConditions200ResponseResultsInnerUpdateRulesMarketCenter + */ +export interface ListConditions200ResponseResultsInnerUpdateRulesMarketCenter { + /** + * Whether or not trades with this condition update the high/low. + * @type {boolean} + * @memberof ListConditions200ResponseResultsInnerUpdateRulesMarketCenter + */ + 'updates_high_low': boolean; + /** + * Whether or not trades with this condition update the open/close. + * @type {boolean} + * @memberof ListConditions200ResponseResultsInnerUpdateRulesMarketCenter + */ + 'updates_open_close': boolean; + /** + * Whether or not trades with this condition update the volume. + * @type {boolean} + * @memberof ListConditions200ResponseResultsInnerUpdateRulesMarketCenter + */ + 'updates_volume': boolean; +} +/** + * + * @export + * @interface ListConditions400Response + */ +export interface ListConditions400Response { + /** + * The total number of results for this request. + * @type {number} + * @memberof ListConditions400Response + */ + 'count': number; + /** + * If present, this value can be used to fetch the next page of data. + * @type {string} + * @memberof ListConditions400Response + */ + 'next_url'?: string; + /** + * A request ID assigned by the server. + * @type {string} + * @memberof ListConditions400Response + */ + 'request_id': string; + /** + * An array of conditions that match your query. + * @type {Array} + * @memberof ListConditions400Response + */ + 'results': Array; + /** + * The status of this request\'s response. + * @type {string} + * @memberof ListConditions400Response + */ + 'status': string; +} +/** + * A list of dividends. + * @export + * @interface ListDividends200Response + */ +export interface ListDividends200Response { + /** + * If present, this value can be used to fetch the next page of data. + * @type {string} + * @memberof ListDividends200Response + */ + 'next_url'?: string; + /** + * A request id assigned by the server. + * @type {string} + * @memberof ListDividends200Response + */ + 'request_id': string; + /** + * An array of results containing the requested data. + * @type {Array} + * @memberof ListDividends200Response + */ + 'results'?: Array; + /** + * The status of this request\'s response. + * @type {string} + * @memberof ListDividends200Response + */ + 'status'?: string; +} +/** + * + * @export + * @interface ListDividends200ResponseResultsInner + */ +export interface ListDividends200ResponseResultsInner { + /** + * The cash amount of the dividend per share owned. + * @type {number} + * @memberof ListDividends200ResponseResultsInner + */ + 'cash_amount': number; + /** + * The currency in which the dividend is paid. + * @type {string} + * @memberof ListDividends200ResponseResultsInner + */ + 'currency'?: string; + /** + * The date that the dividend was announced. + * @type {string} + * @memberof ListDividends200ResponseResultsInner + */ + 'declaration_date'?: string; + /** + * The type of dividend. Dividends that have been paid and/or are expected to be paid on consistent schedules are denoted as CD. Special Cash dividends that have been paid that are infrequent or unusual, and/or can not be expected to occur in the future are denoted as SC. Long-Term and Short-Term capital gain distributions are denoted as LT and ST, respectively. + * @type {string} + * @memberof ListDividends200ResponseResultsInner + */ + 'dividend_type': ListDividends200ResponseResultsInnerDividendTypeEnum; + /** + * The date that the stock first trades without the dividend, determined by the exchange. + * @type {string} + * @memberof ListDividends200ResponseResultsInner + */ + 'ex_dividend_date': string; + /** + * The number of times per year the dividend is paid out. Possible values are 0 (one-time), 1 (annually), 2 (bi-annually), 4 (quarterly), 12 (monthly), 24 (bi-monthly), and 52 (weekly). + * @type {number} + * @memberof ListDividends200ResponseResultsInner + */ + 'frequency': number; + /** + * The unique identifier of the dividend. + * @type {string} + * @memberof ListDividends200ResponseResultsInner + */ + 'id': string; + /** + * The date that the dividend is paid out. + * @type {string} + * @memberof ListDividends200ResponseResultsInner + */ + 'pay_date'?: string; + /** + * The date that the stock must be held to receive the dividend, set by the company. + * @type {string} + * @memberof ListDividends200ResponseResultsInner + */ + 'record_date'?: string; + /** + * The ticker symbol of the dividend. + * @type {string} + * @memberof ListDividends200ResponseResultsInner + */ + 'ticker': string; +} + +/** + * @export + * @enum {string} + */ +export enum ListDividends200ResponseResultsInnerDividendTypeEnum { + Cd = 'CD', + Sc = 'SC', + Lt = 'LT', + St = 'ST' +} + +/** + * + * @export + * @interface ListExchanges200Response + */ +export interface ListExchanges200Response { + /** + * The total number of results for this request. + * @type {number} + * @memberof ListExchanges200Response + */ + 'count'?: number; + /** + * A request ID assigned by the server. + * @type {string} + * @memberof ListExchanges200Response + */ + 'request_id': string; + /** + * An array of results containing the requested data. + * @type {Array} + * @memberof ListExchanges200Response + */ + 'results'?: Array; + /** + * The status of this request\'s response. + * @type {string} + * @memberof ListExchanges200Response + */ + 'status': string; +} +/** + * An entity that reports trades. + * @export + * @interface ListExchanges200ResponseResultsInner + */ +export interface ListExchanges200ResponseResultsInner { + /** + * A commonly used abbreviation for this exchange. + * @type {string} + * @memberof ListExchanges200ResponseResultsInner + */ + 'acronym'?: string; + /** + * An identifier for a group of similar financial instruments. + * @type {string} + * @memberof ListExchanges200ResponseResultsInner + */ + 'asset_class': ListExchanges200ResponseResultsInnerAssetClassEnum; + /** + * A unique identifier used by Massive.com for this exchange. + * @type {number} + * @memberof ListExchanges200ResponseResultsInner + */ + 'id': number; + /** + * An identifier for a geographical location. + * @type {string} + * @memberof ListExchanges200ResponseResultsInner + */ + 'locale': ListExchanges200ResponseResultsInnerLocaleEnum; + /** + * The Market Identifier Code of this exchange (see ISO 10383). + * @type {string} + * @memberof ListExchanges200ResponseResultsInner + */ + 'mic'?: string; + /** + * Name of this exchange. + * @type {string} + * @memberof ListExchanges200ResponseResultsInner + */ + 'name': string; + /** + * The MIC of the entity that operates this exchange. + * @type {string} + * @memberof ListExchanges200ResponseResultsInner + */ + 'operating_mic'?: string; + /** + * The ID used by SIP\'s to represent this exchange. + * @type {string} + * @memberof ListExchanges200ResponseResultsInner + */ + 'participant_id'?: string; + /** + * Represents the type of exchange. + * @type {string} + * @memberof ListExchanges200ResponseResultsInner + */ + 'type': ListExchanges200ResponseResultsInnerTypeEnum; + /** + * A link to this exchange\'s website, if one exists. + * @type {string} + * @memberof ListExchanges200ResponseResultsInner + */ + 'url'?: string; +} + +/** + * @export + * @enum {string} + */ +export enum ListExchanges200ResponseResultsInnerAssetClassEnum { + Stocks = 'stocks', + Options = 'options', + Crypto = 'crypto', + Fx = 'fx', + Futures = 'futures' +} +/** + * @export + * @enum {string} + */ +export enum ListExchanges200ResponseResultsInnerLocaleEnum { + Us = 'us', + Global = 'global' +} +/** + * @export + * @enum {string} + */ +export enum ListExchanges200ResponseResultsInnerTypeEnum { + Exchange = 'exchange', + Trf = 'TRF', + Sip = 'SIP' +} + +/** + * + * @export + * @interface ListExchanges400Response + */ +export interface ListExchanges400Response { + /** + * The total number of results for this request. + * @type {number} + * @memberof ListExchanges400Response + */ + 'count'?: number; + /** + * A request ID assigned by the server. + * @type {string} + * @memberof ListExchanges400Response + */ + 'request_id': string; + /** + * The status of this request\'s response. + * @type {string} + * @memberof ListExchanges400Response + */ + 'status': string; +} +/** + * + * @export + * @interface ListFinancials200Response + */ +export interface ListFinancials200Response { + /** + * The total number of results for this request. + * @type {number} + * @memberof ListFinancials200Response + */ + 'count': number; + /** + * If present, this value can be used to fetch the next page of data. + * @type {string} + * @memberof ListFinancials200Response + */ + 'next_url'?: string; + /** + * A request id assigned by the server. + * @type {string} + * @memberof ListFinancials200Response + */ + 'request_id': string; + /** + * An array of results containing the requested data. + * @type {Array} + * @memberof ListFinancials200Response + */ + 'results': Array; + /** + * The status of this request\'s response. + * @type {string} + * @memberof ListFinancials200Response + */ + 'status': string; +} +/** + * + * @export + * @interface ListFinancials200ResponseResultsInner + */ +export interface ListFinancials200ResponseResultsInner { + /** + * The datetime (EST timezone) the filing was accepted by EDGAR in YYYYMMDDHHMMSS format. + * @type {string} + * @memberof ListFinancials200ResponseResultsInner + */ + 'acceptance_datetime'?: string; + /** + * The CIK number for the company. + * @type {string} + * @memberof ListFinancials200ResponseResultsInner + */ + 'cik': string; + /** + * The company name. + * @type {string} + * @memberof ListFinancials200ResponseResultsInner + */ + 'company_name': string; + /** + * The end date of the period that these financials cover in YYYYMMDD format. + * @type {string} + * @memberof ListFinancials200ResponseResultsInner + */ + 'end_date'?: string; + /** + * The date that the SEC filing which these financials were derived from was made available. Note that this is not necessarily the date when this information became public, as some companies may publish a press release before filing with the SEC. + * @type {string} + * @memberof ListFinancials200ResponseResultsInner + */ + 'filing_date'?: string; + /** + * + * @type {ListFinancials200ResponseResultsInnerFinancials} + * @memberof ListFinancials200ResponseResultsInner + */ + 'financials': ListFinancials200ResponseResultsInnerFinancials; + /** + * Fiscal period of the report according to the company (Q1, Q2, Q3, Q4, or FY). + * @type {string} + * @memberof ListFinancials200ResponseResultsInner + */ + 'fiscal_period': string; + /** + * Fiscal year of the report according to the company. + * @type {string} + * @memberof ListFinancials200ResponseResultsInner + */ + 'fiscal_year'?: string; + /** + * The Standard Industrial Classification (SIC) code for the company. + * @type {string} + * @memberof ListFinancials200ResponseResultsInner + */ + 'sic'?: string; + /** + * The URL of the specific XBRL instance document within the SEC filing that these financials were derived from. + * @type {string} + * @memberof ListFinancials200ResponseResultsInner + */ + 'source_filing_file_url'?: string; + /** + * The URL of the SEC filing that these financials were derived from. + * @type {string} + * @memberof ListFinancials200ResponseResultsInner + */ + 'source_filing_url'?: string; + /** + * The start date of the period that these financials cover in YYYYMMDD format. + * @type {string} + * @memberof ListFinancials200ResponseResultsInner + */ + 'start_date'?: string; + /** + * The list of ticker symbols for the company. + * @type {Array} + * @memberof ListFinancials200ResponseResultsInner + */ + 'tickers'?: Array; + /** + * The timeframe of the report (quarterly, annual or ttm). + * @type {string} + * @memberof ListFinancials200ResponseResultsInner + */ + 'timeframe': string; +} +/** + * Structured financial statements with detailed data points and metadata. + * @export + * @interface ListFinancials200ResponseResultsInnerFinancials + */ +export interface ListFinancials200ResponseResultsInnerFinancials { + /** + * + * @type {ListFinancials200ResponseResultsInnerFinancialsBalanceSheet} + * @memberof ListFinancials200ResponseResultsInnerFinancials + */ + 'balance_sheet'?: ListFinancials200ResponseResultsInnerFinancialsBalanceSheet; + /** + * Cash flow statement. The keys in this object can be any of the fields listed in the Cash Flow Statement section of the financials API glossary of terms. See the attributes of the objects within `balance_sheet` for more details. + * @type {object} + * @memberof ListFinancials200ResponseResultsInnerFinancials + */ + 'cash_flow_statement'?: object; + /** + * Comprehensive income. The keys in this object can be any of the fields listed in the Comprehensive Income section of the financials API glossary of terms. See the attributes of the objects within `balance_sheet` for more details. + * @type {object} + * @memberof ListFinancials200ResponseResultsInnerFinancials + */ + 'comprehensive_income'?: object; + /** + * Income statement. The keys in this object can be any of the fields listed in the Income Statement section of the financials API glossary of terms. See the attributes of the objects within `balance_sheet` for more details. + * @type {object} + * @memberof ListFinancials200ResponseResultsInnerFinancials + */ + 'income_statement'?: object; +} +/** + * Balance sheet. The keys in this object can be any of the fields listed in the Balance Sheet section of the financials API glossary of terms. + * @export + * @interface ListFinancials200ResponseResultsInnerFinancialsBalanceSheet + */ +export interface ListFinancials200ResponseResultsInnerFinancialsBalanceSheet { + /** + * + * @type {ListFinancials200ResponseResultsInnerFinancialsBalanceSheet} + * @memberof ListFinancials200ResponseResultsInnerFinancialsBalanceSheet + */ + '*'?: ListFinancials200ResponseResultsInnerFinancialsBalanceSheet; +} +/** + * + * @export + * @interface ListIPOs200Response + */ +export interface ListIPOs200Response { + /** + * If present, this value can be used to fetch the next page of data. + * @type {string} + * @memberof ListIPOs200Response + */ + 'next_url'?: string; + /** + * A request id assigned by the server. + * @type {string} + * @memberof ListIPOs200Response + */ + 'request_id'?: string; + /** + * An array of results containing the requested data. + * @type {Array} + * @memberof ListIPOs200Response + */ + 'results'?: Array; + /** + * The status of this request\'s response. + * @type {string} + * @memberof ListIPOs200Response + */ + 'status'?: string; +} +/** + * + * @export + * @interface ListIPOs200ResponseResultsInner + */ +export interface ListIPOs200ResponseResultsInner { + /** + * The date when the IPO event was announced. + * @type {string} + * @memberof ListIPOs200ResponseResultsInner + */ + 'announced_date'?: string; + /** + * Underlying currency of the security. + * @type {string} + * @memberof ListIPOs200ResponseResultsInner + */ + 'currency_code'?: string; + /** + * The price set by the company and its underwriters before the IPO goes live. + * @type {number} + * @memberof ListIPOs200ResponseResultsInner + */ + 'final_issue_price'?: number; + /** + * The highest price within the IPO price range that the company might use to price the shares. + * @type {number} + * @memberof ListIPOs200ResponseResultsInner + */ + 'highest_offer_price'?: number; + /** + * The status of the IPO event. IPO events start out as status \"rumor\" or \"pending\". On listing day, the status changes to \"new\". After the listing day, the status changes to \"history\". The status \"direct_listing_process\" corresponds to a type of offering where, instead of going through all the IPO processes, the company decides to list its shares directly on an exchange, without using an investment bank or other intermediaries. This is called a direct listing, direct placement, or direct public offering (DPO). + * @type {string} + * @memberof ListIPOs200ResponseResultsInner + */ + 'ipo_status': ListIPOs200ResponseResultsInnerIpoStatusEnum; + /** + * International Securities Identification Number. This is a unique twelve-digit code that is assigned to every security issuance in the world. + * @type {string} + * @memberof ListIPOs200ResponseResultsInner + */ + 'isin'?: string; + /** + * Name of issuer. + * @type {string} + * @memberof ListIPOs200ResponseResultsInner + */ + 'issuer_name': string; + /** + * The date when the IPO event was last modified. + * @type {string} + * @memberof ListIPOs200ResponseResultsInner + */ + 'last_updated': string; + /** + * First trading date for the newly listed entity. + * @type {string} + * @memberof ListIPOs200ResponseResultsInner + */ + 'listing_date'?: string; + /** + * The minimum number of shares that can be bought or sold in a single transaction. + * @type {number} + * @memberof ListIPOs200ResponseResultsInner + */ + 'lot_size'?: number; + /** + * The lowest price within the IPO price range that the company is willing to offer its shares to investors. + * @type {number} + * @memberof ListIPOs200ResponseResultsInner + */ + 'lowest_offer_price'?: number; + /** + * The upper limit of the shares that the company is offering to investors. + * @type {number} + * @memberof ListIPOs200ResponseResultsInner + */ + 'max_shares_offered'?: number; + /** + * The lower limit of shares that the company is willing to sell in the IPO. + * @type {number} + * @memberof ListIPOs200ResponseResultsInner + */ + 'min_shares_offered'?: number; + /** + * Market Identifier Code (MIC) of the primary exchange where the security is listed. The Market Identifier Code (MIC) (ISO 10383) is a unique identification code used to identify securities trading exchanges, regulated and non-regulated trading markets. + * @type {string} + * @memberof ListIPOs200ResponseResultsInner + */ + 'primary_exchange'?: string; + /** + * Description of the security. + * @type {string} + * @memberof ListIPOs200ResponseResultsInner + */ + 'security_description'?: string; + /** + * The classification of the stock. For example, \"CS\" stands for Common Stock. + * @type {string} + * @memberof ListIPOs200ResponseResultsInner + */ + 'security_type': string; + /** + * The total number of shares that the company has issued and are held by investors. + * @type {number} + * @memberof ListIPOs200ResponseResultsInner + */ + 'shares_outstanding'?: number; + /** + * The ticker symbol of the IPO event. + * @type {string} + * @memberof ListIPOs200ResponseResultsInner + */ + 'ticker': string; + /** + * The total amount raised by the company for IPO. + * @type {number} + * @memberof ListIPOs200ResponseResultsInner + */ + 'total_offer_size'?: number; + /** + * This is a unique nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades. + * @type {string} + * @memberof ListIPOs200ResponseResultsInner + */ + 'us_code'?: string; +} + +/** + * @export + * @enum {string} + */ +export enum ListIPOs200ResponseResultsInnerIpoStatusEnum { + DirectListingProcess = 'direct_listing_process', + History = 'history', + New = 'new', + Pending = 'pending', + Postponed = 'postponed', + Rumor = 'rumor', + Withdrawn = 'withdrawn' +} + +/** + * + * @export + * @interface ListNews200Response + */ +export interface ListNews200Response { + /** + * The total number of results for this request. + * @type {number} + * @memberof ListNews200Response + */ + 'count'?: number; + /** + * If present, this value can be used to fetch the next page of data. + * @type {string} + * @memberof ListNews200Response + */ + 'next_url'?: string; + /** + * A request id assigned by the server. + * @type {string} + * @memberof ListNews200Response + */ + 'request_id'?: string; + /** + * An array of results containing the requested data. + * @type {Array} + * @memberof ListNews200Response + */ + 'results'?: Array; + /** + * The status of this request\'s response. + * @type {string} + * @memberof ListNews200Response + */ + 'status'?: string; +} +/** + * + * @export + * @interface ListNews200ResponseResultsInner + */ +export interface ListNews200ResponseResultsInner { + /** + * The mobile friendly Accelerated Mobile Page (AMP) URL. + * @type {string} + * @memberof ListNews200ResponseResultsInner + */ + 'amp_url'?: string; + /** + * A link to the news article. + * @type {string} + * @memberof ListNews200ResponseResultsInner + */ + 'article_url': string; + /** + * The article\'s author. + * @type {string} + * @memberof ListNews200ResponseResultsInner + */ + 'author': string; + /** + * A description of the article. + * @type {string} + * @memberof ListNews200ResponseResultsInner + */ + 'description'?: string; + /** + * Unique identifier for the article. + * @type {string} + * @memberof ListNews200ResponseResultsInner + */ + 'id': string; + /** + * The article\'s image URL. + * @type {string} + * @memberof ListNews200ResponseResultsInner + */ + 'image_url'?: string; + /** + * The insights related to the article. + * @type {Array} + * @memberof ListNews200ResponseResultsInner + */ + 'insights'?: Array; + /** + * The keywords associated with the article (which will vary depending on the publishing source). + * @type {Array} + * @memberof ListNews200ResponseResultsInner + */ + 'keywords'?: Array; + /** + * The UTC date and time when the article was published, formatted in RFC3339 standard (e.g. YYYY-MM-DDTHH:MM:SSZ). + * @type {string} + * @memberof ListNews200ResponseResultsInner + */ + 'published_utc': string; + /** + * + * @type {ListNews200ResponseResultsInnerPublisher} + * @memberof ListNews200ResponseResultsInner + */ + 'publisher': ListNews200ResponseResultsInnerPublisher; + /** + * The ticker symbols associated with the article. + * @type {Array} + * @memberof ListNews200ResponseResultsInner + */ + 'tickers': Array; + /** + * The title of the news article. + * @type {string} + * @memberof ListNews200ResponseResultsInner + */ + 'title': string; +} +/** + * + * @export + * @interface ListNews200ResponseResultsInnerInsightsInner + */ +export interface ListNews200ResponseResultsInnerInsightsInner { + /** + * The sentiment of the insight. + * @type {string} + * @memberof ListNews200ResponseResultsInnerInsightsInner + */ + 'sentiment': ListNews200ResponseResultsInnerInsightsInnerSentimentEnum; + /** + * The reasoning behind the sentiment. + * @type {string} + * @memberof ListNews200ResponseResultsInnerInsightsInner + */ + 'sentiment_reasoning': string; + /** + * The ticker symbol associated with the insight. + * @type {string} + * @memberof ListNews200ResponseResultsInnerInsightsInner + */ + 'ticker': string; +} + +/** + * @export + * @enum {string} + */ +export enum ListNews200ResponseResultsInnerInsightsInnerSentimentEnum { + Positive = 'positive', + Neutral = 'neutral', + Negative = 'negative' +} + +/** + * Details the source of the news article, including the publisher\'s name, logo, and homepage URLs. This information helps users identify and access the original source of news content. + * @export + * @interface ListNews200ResponseResultsInnerPublisher + */ +export interface ListNews200ResponseResultsInnerPublisher { + /** + * The publisher\'s homepage favicon URL. + * @type {string} + * @memberof ListNews200ResponseResultsInnerPublisher + */ + 'favicon_url'?: string; + /** + * The publisher\'s homepage URL. + * @type {string} + * @memberof ListNews200ResponseResultsInnerPublisher + */ + 'homepage_url': string; + /** + * The publisher\'s logo URL. + * @type {string} + * @memberof ListNews200ResponseResultsInnerPublisher + */ + 'logo_url': string; + /** + * The publisher\'s name. + * @type {string} + * @memberof ListNews200ResponseResultsInnerPublisher + */ + 'name': string; +} +/** + * @type ListNewsPublishedUtcParameter + * @export + */ +export type ListNewsPublishedUtcParameter = string; + +/** + * + * @export + * @interface ListOptionsContracts200Response + */ +export interface ListOptionsContracts200Response { + /** + * If present, this value can be used to fetch the next page of data. + * @type {string} + * @memberof ListOptionsContracts200Response + */ + 'next_url'?: string; + /** + * A request id assigned by the server. + * @type {string} + * @memberof ListOptionsContracts200Response + */ + 'request_id'?: string; + /** + * An array of results containing the requested data. + * @type {Array} + * @memberof ListOptionsContracts200Response + */ + 'results'?: Array; + /** + * The status of this request\'s response. + * @type {string} + * @memberof ListOptionsContracts200Response + */ + 'status'?: string; +} +/** + * Contains the requested data for the specified options contract. + * @export + * @interface ListOptionsContracts200ResponseResultsInner + */ +export interface ListOptionsContracts200ResponseResultsInner { + /** + * If an option contract has additional underlyings or deliverables associated with it, they will appear here. See here for some examples of what might cause a contract to have additional underlyings. + * @type {Array} + * @memberof ListOptionsContracts200ResponseResultsInner + */ + 'additional_underlyings'?: Array; + /** + * The 6 letter CFI code of the contract (defined in ISO 10962) + * @type {string} + * @memberof ListOptionsContracts200ResponseResultsInner + */ + 'cfi'?: string; + /** + * The type of contract. Can be \"put\", \"call\", or in some rare cases, \"other\". + * @type {string} + * @memberof ListOptionsContracts200ResponseResultsInner + */ + 'contract_type'?: string; + /** + * The correction number for this option contract. + * @type {number} + * @memberof ListOptionsContracts200ResponseResultsInner + */ + 'correction'?: number; + /** + * The exercise style of this contract. See this link for more details on exercise styles. + * @type {string} + * @memberof ListOptionsContracts200ResponseResultsInner + */ + 'exercise_style'?: ListOptionsContracts200ResponseResultsInnerExerciseStyleEnum; + /** + * The contract\'s expiration date in YYYY-MM-DD format. + * @type {string} + * @memberof ListOptionsContracts200ResponseResultsInner + */ + 'expiration_date'?: string; + /** + * The MIC code of the primary exchange that this contract is listed on. + * @type {string} + * @memberof ListOptionsContracts200ResponseResultsInner + */ + 'primary_exchange'?: string; + /** + * The number of shares per contract for this contract. + * @type {number} + * @memberof ListOptionsContracts200ResponseResultsInner + */ + 'shares_per_contract'?: number; + /** + * The strike price of the option contract. + * @type {number} + * @memberof ListOptionsContracts200ResponseResultsInner + */ + 'strike_price'?: number; + /** + * The ticker for the option contract. + * @type {string} + * @memberof ListOptionsContracts200ResponseResultsInner + */ + 'ticker'?: string; + /** + * The underlying ticker that the option contract relates to. + * @type {string} + * @memberof ListOptionsContracts200ResponseResultsInner + */ + 'underlying_ticker'?: string; +} + +/** + * @export + * @enum {string} + */ +export enum ListOptionsContracts200ResponseResultsInnerExerciseStyleEnum { + American = 'american', + European = 'european', + Bermudan = 'bermudan' +} + +/** + * + * @export + * @interface ListOptionsContracts200ResponseResultsInnerAdditionalUnderlyingsInner + */ +export interface ListOptionsContracts200ResponseResultsInnerAdditionalUnderlyingsInner { + /** + * The number of shares per contract of the additional underlying, or the cash-in-lieu amount of the currency. + * @type {number} + * @memberof ListOptionsContracts200ResponseResultsInnerAdditionalUnderlyingsInner + */ + 'amount'?: number; + /** + * The type of the additional underlying asset, either equity or currency. + * @type {string} + * @memberof ListOptionsContracts200ResponseResultsInnerAdditionalUnderlyingsInner + */ + 'type'?: string; + /** + * The name of the additional underlying asset. + * @type {string} + * @memberof ListOptionsContracts200ResponseResultsInnerAdditionalUnderlyingsInner + */ + 'underlying'?: string; +} +/** + * + * @export + * @interface ListStockSplits200Response + */ +export interface ListStockSplits200Response { + /** + * If present, this value can be used to fetch the next page of data. + * @type {string} + * @memberof ListStockSplits200Response + */ + 'next_url'?: string; + /** + * A request id assigned by the server. + * @type {string} + * @memberof ListStockSplits200Response + */ + 'request_id'?: string; + /** + * An array of results containing the requested data. + * @type {Array} + * @memberof ListStockSplits200Response + */ + 'results'?: Array; + /** + * The status of this request\'s response. + * @type {string} + * @memberof ListStockSplits200Response + */ + 'status'?: string; +} +/** + * + * @export + * @interface ListStockSplits200ResponseResultsInner + */ +export interface ListStockSplits200ResponseResultsInner { + /** + * The execution date of the stock split. On this date the stock split was applied. + * @type {string} + * @memberof ListStockSplits200ResponseResultsInner + */ + 'execution_date': string; + /** + * The unique identifier for this stock split. + * @type {string} + * @memberof ListStockSplits200ResponseResultsInner + */ + 'id': string; + /** + * The second number in the split ratio. For example: In a 2-for-1 split, split_from would be 1. + * @type {number} + * @memberof ListStockSplits200ResponseResultsInner + */ + 'split_from': number; + /** + * The first number in the split ratio. For example: In a 2-for-1 split, split_to would be 2. + * @type {number} + * @memberof ListStockSplits200ResponseResultsInner + */ + 'split_to': number; + /** + * The ticker symbol of the stock split. + * @type {string} + * @memberof ListStockSplits200ResponseResultsInner + */ + 'ticker': string; +} +/** + * + * @export + * @interface ListTickerTypes200Response + */ +export interface ListTickerTypes200Response { + /** + * The total number of results for this request. + * @type {number} + * @memberof ListTickerTypes200Response + */ + 'count'?: number; + /** + * A request ID assigned by the server. + * @type {string} + * @memberof ListTickerTypes200Response + */ + 'request_id': string; + /** + * + * @type {Array} + * @memberof ListTickerTypes200Response + */ + 'results'?: Array; + /** + * The status of this request\'s response. + * @type {string} + * @memberof ListTickerTypes200Response + */ + 'status': string; +} +/** + * Describes the type of financial instrument represented by a ticker. + * @export + * @interface ListTickerTypes200ResponseResultsInner + */ +export interface ListTickerTypes200ResponseResultsInner { + /** + * An identifier for a group of similar financial instruments. + * @type {string} + * @memberof ListTickerTypes200ResponseResultsInner + */ + 'asset_class': ListTickerTypes200ResponseResultsInnerAssetClassEnum; + /** + * A code used by Massive.com to refer to this ticker type. + * @type {string} + * @memberof ListTickerTypes200ResponseResultsInner + */ + 'code': string; + /** + * A short description of this ticker type. + * @type {string} + * @memberof ListTickerTypes200ResponseResultsInner + */ + 'description': string; + /** + * An identifier for a geographical location. + * @type {string} + * @memberof ListTickerTypes200ResponseResultsInner + */ + 'locale': ListTickerTypes200ResponseResultsInnerLocaleEnum; +} + +/** + * @export + * @enum {string} + */ +export enum ListTickerTypes200ResponseResultsInnerAssetClassEnum { + Stocks = 'stocks', + Options = 'options', + Crypto = 'crypto', + Fx = 'fx', + Indices = 'indices' +} +/** + * @export + * @enum {string} + */ +export enum ListTickerTypes200ResponseResultsInnerLocaleEnum { + Us = 'us', + Global = 'global' +} + +/** + * + * @export + * @interface ListTickers200Response + */ +export interface ListTickers200Response { + /** + * The total number of results for this request. + * @type {number} + * @memberof ListTickers200Response + */ + 'count'?: number; + /** + * If present, this value can be used to fetch the next page of data. + * @type {string} + * @memberof ListTickers200Response + */ + 'next_url'?: string; + /** + * A request id assigned by the server. + * @type {string} + * @memberof ListTickers200Response + */ + 'request_id'?: string; + /** + * An array of tickers that match your query. Note: Although you can query by CUSIP, due to legal reasons we do not return the CUSIP in the response. + * @type {Array} + * @memberof ListTickers200Response + */ + 'results'?: Array; + /** + * The status of this request\'s response. + * @type {string} + * @memberof ListTickers200Response + */ + 'status'?: string; +} +/** + * + * @export + * @interface ListTickers200ResponseResultsInner + */ +export interface ListTickers200ResponseResultsInner { + /** + * Whether or not the asset is actively traded. False means the asset has been delisted. + * @type {boolean} + * @memberof ListTickers200ResponseResultsInner + */ + 'active'?: boolean; + /** + * The name of the currency that this asset is priced against. + * @type {string} + * @memberof ListTickers200ResponseResultsInner + */ + 'base_currency_name'?: string; + /** + * The ISO 4217 code of the currency that this asset is priced against. + * @type {string} + * @memberof ListTickers200ResponseResultsInner + */ + 'base_currency_symbol'?: string; + /** + * The CIK number for this ticker. Find more information [here](https://en.wikipedia.org/wiki/Central_Index_Key). + * @type {string} + * @memberof ListTickers200ResponseResultsInner + */ + 'cik'?: string; + /** + * The composite OpenFIGI number for this ticker. Find more information [here](https://www.openfigi.com/about/figi) + * @type {string} + * @memberof ListTickers200ResponseResultsInner + */ + 'composite_figi'?: string; + /** + * The name of the currency that this asset is traded with. + * @type {string} + * @memberof ListTickers200ResponseResultsInner + */ + 'currency_name'?: string; + /** + * The ISO 4217 code of the currency that this asset is traded with. + * @type {string} + * @memberof ListTickers200ResponseResultsInner + */ + 'currency_symbol'?: string; + /** + * The last date that the asset was traded. + * @type {string} + * @memberof ListTickers200ResponseResultsInner + */ + 'delisted_utc'?: string; + /** + * The information is accurate up to this time. + * @type {string} + * @memberof ListTickers200ResponseResultsInner + */ + 'last_updated_utc'?: string; + /** + * The locale of the asset. + * @type {string} + * @memberof ListTickers200ResponseResultsInner + */ + 'locale': ListTickers200ResponseResultsInnerLocaleEnum; + /** + * The market type of the asset. + * @type {string} + * @memberof ListTickers200ResponseResultsInner + */ + 'market': ListTickers200ResponseResultsInnerMarketEnum; + /** + * The name of the asset. For stocks/equities this will be the companies registered name. For crypto/fx this will be the name of the currency or coin pair. + * @type {string} + * @memberof ListTickers200ResponseResultsInner + */ + 'name': string; + /** + * The ISO code of the primary listing exchange for this asset. + * @type {string} + * @memberof ListTickers200ResponseResultsInner + */ + 'primary_exchange'?: string; + /** + * The share Class OpenFIGI number for this ticker. Find more information [here](https://www.openfigi.com/about/figi) + * @type {string} + * @memberof ListTickers200ResponseResultsInner + */ + 'share_class_figi'?: string; + /** + * The exchange symbol that this item is traded under. + * @type {string} + * @memberof ListTickers200ResponseResultsInner + */ + 'ticker': string; + /** + * The type of the asset. Find the types that we support via our [Ticker Types API](https://massive.com/docs/stocks/get_v3_reference_tickers_types). + * @type {string} + * @memberof ListTickers200ResponseResultsInner + */ + 'type'?: string; +} + +/** + * @export + * @enum {string} + */ +export enum ListTickers200ResponseResultsInnerLocaleEnum { + Us = 'us', + Global = 'global' +} +/** + * @export + * @enum {string} + */ +export enum ListTickers200ResponseResultsInnerMarketEnum { + Stocks = 'stocks', + Crypto = 'crypto', + Fx = 'fx', + Otc = 'otc', + Indices = 'indices' +} + +/** + * + * @export + * @interface Locales + */ +export interface Locales { + /** + * + * @type {Array} + * @memberof Locales + */ + 'results'?: Array; +} +/** + * + * @export + * @interface LocalesResultsInner + */ +export interface LocalesResultsInner { + /** + * An abbreviated country name. + * @type {string} + * @memberof LocalesResultsInner + */ + 'locale'?: string; + /** + * The name of the country. + * @type {string} + * @memberof LocalesResultsInner + */ + 'name'?: string; +} +/** + * A dynamic key from the results set + * @export + * @interface MapKey + */ +export interface MapKey { + /** + * The descriptive name of this results key + * @type {string} + * @memberof MapKey + */ + 'name'?: string; + /** + * The data type of this results key + * @type {string} + * @memberof MapKey + */ + 'type'?: MapKeyTypeEnum; +} + +/** + * @export + * @enum {string} + */ +export enum MapKeyTypeEnum { + String = 'string', + Int = 'int', + Int64 = 'int64', + Float64 = 'float64' +} + +/** + * + * @export + * @interface MarketHolidayInner + */ +export interface MarketHolidayInner { + /** + * The market close time on the holiday (if it\'s not closed). + * @type {string} + * @memberof MarketHolidayInner + */ + 'close'?: string; + /** + * The date of the holiday. + * @type {string} + * @memberof MarketHolidayInner + */ + 'date': string; + /** + * Which market the record is for. + * @type {string} + * @memberof MarketHolidayInner + */ + 'exchange': string; + /** + * The name of the holiday. + * @type {string} + * @memberof MarketHolidayInner + */ + 'name': string; + /** + * The market open time on the holiday (if it\'s not closed). + * @type {string} + * @memberof MarketHolidayInner + */ + 'open'?: string; + /** + * The status of the market on the holiday. + * @type {string} + * @memberof MarketHolidayInner + */ + 'status': string; +} +/** + * + * @export + * @interface MarketStatus + */ +export interface MarketStatus { + /** + * Whether or not the market is in post-market hours. + * @type {boolean} + * @memberof MarketStatus + */ + 'afterHours'?: boolean; + /** + * + * @type {MarketStatusCurrencies} + * @memberof MarketStatus + */ + 'currencies'?: MarketStatusCurrencies; + /** + * Whether or not the market is in pre-market hours. + * @type {boolean} + * @memberof MarketStatus + */ + 'earlyHours'?: boolean; + /** + * + * @type {MarketStatusExchanges} + * @memberof MarketStatus + */ + 'exchanges'?: MarketStatusExchanges; + /** + * The status of the market as a whole. + * @type {string} + * @memberof MarketStatus + */ + 'market'?: string; + /** + * The current time of the server. + * @type {string} + * @memberof MarketStatus + */ + 'serverTime'?: string; +} +/** + * + * @export + * @interface MarketStatusCurrencies + */ +export interface MarketStatusCurrencies { + /** + * The status of the crypto market. + * @type {string} + * @memberof MarketStatusCurrencies + */ + 'crypto'?: string; + /** + * The status of the forex market. + * @type {string} + * @memberof MarketStatusCurrencies + */ + 'fx'?: string; +} +/** + * + * @export + * @interface MarketStatusExchanges + */ +export interface MarketStatusExchanges { + /** + * The status of the Nasdaq market. + * @type {string} + * @memberof MarketStatusExchanges + */ + 'nasdaq'?: string; + /** + * The status of the NYSE market. + * @type {string} + * @memberof MarketStatusExchanges + */ + 'nyse'?: string; + /** + * The status of the OTC market. + * @type {string} + * @memberof MarketStatusExchanges + */ + 'otc'?: string; +} +/** + * + * @export + * @interface Markets + */ +export interface Markets { + /** + * A list of supported markets. + * @type {Array} + * @memberof Markets + */ + 'results'?: Array; +} +/** + * + * @export + * @interface MarketsResultsInner + */ +export interface MarketsResultsInner { + /** + * A description of the market. + * @type {string} + * @memberof MarketsResultsInner + */ + 'desc'?: string; + /** + * The name of the market. + * @type {string} + * @memberof MarketsResultsInner + */ + 'market'?: string; +} +/** + * @type ModelDate + * @export + */ +export type ModelDate = string; + +/** + * A mapping of the keys returned in the results to their descriptive name and data types. + * @export + * @interface ModelMap + */ +export interface ModelMap { + /** + * + * @type {MapKey} + * @memberof ModelMap + */ + 'key'?: MapKey; +} +/** + * + * @export + * @interface NewsInner + */ +export interface NewsInner { + /** + * A URL of the image for the news article, if found. + * @type {string} + * @memberof NewsInner + */ + 'image'?: string; + /** + * A list of common keywords related to the news article. + * @type {Array} + * @memberof NewsInner + */ + 'keywords'?: Array; + /** + * The publication source of the article. + * @type {string} + * @memberof NewsInner + */ + 'source'?: string; + /** + * A summary of the news article. + * @type {string} + * @memberof NewsInner + */ + 'summary'?: string; + /** + * A list of ticker symbols relating to the article. + * @type {Array} + * @memberof NewsInner + */ + 'symbols'?: Array; + /** + * The timestamp of the news article. + * @type {string} + * @memberof NewsInner + */ + 'timestamp'?: string; + /** + * The title of the news article. + * @type {string} + * @memberof NewsInner + */ + 'title'?: string; + /** + * A direct link to the news article from its source publication. + * @type {string} + * @memberof NewsInner + */ + 'url'?: string; +} +/** + * + * @export + * @interface PaginationHooksBase + */ +export interface PaginationHooksBase { + /** + * If present, this value can be used to fetch the next page of data. + * @type {string} + * @memberof PaginationHooksBase + */ + 'next_url'?: string; +} +/** + * + * @export + * @interface RatingSection + */ +export interface RatingSection { + /** + * Analyst Rating at current month + * @type {number} + * @memberof RatingSection + */ + 'current': number; + /** + * Analyst Ratings at 1 month in the future + * @type {number} + * @memberof RatingSection + */ + 'month1': number; + /** + * Analyst Ratings at 2 month in the future + * @type {number} + * @memberof RatingSection + */ + 'month2': number; + /** + * Analyst Ratings at 3 month in the future + * @type {number} + * @memberof RatingSection + */ + 'month3': number; + /** + * Analyst Ratings at 4 month in the future + * @type {number} + * @memberof RatingSection + */ + 'month4'?: number; + /** + * Analyst Ratings at 5 month in the future + * @type {number} + * @memberof RatingSection + */ + 'month5'?: number; +} +/** + * + * @export + * @interface RequestIdBase + */ +export interface RequestIdBase { + /** + * A request id assigned by the server. + * @type {string} + * @memberof RequestIdBase + */ + 'request_id': string; +} +/** + * + * @export + * @interface SnapshotMinOHLCV + */ +export interface SnapshotMinOHLCV { + /** + * The close price for the symbol in the given time period. + * @type {number} + * @memberof SnapshotMinOHLCV + */ + 'c'?: number; + /** + * The highest price for the symbol in the given time period. + * @type {number} + * @memberof SnapshotMinOHLCV + */ + 'h'?: number; + /** + * The lowest price for the symbol in the given time period. + * @type {number} + * @memberof SnapshotMinOHLCV + */ + 'l'?: number; + /** + * The number of transactions in the aggregate window. + * @type {number} + * @memberof SnapshotMinOHLCV + */ + 'n'?: number; + /** + * The open price for the symbol in the given time period. + * @type {number} + * @memberof SnapshotMinOHLCV + */ + 'o'?: number; + /** + * The Unix millisecond timestamp for the start of the aggregate window. + * @type {number} + * @memberof SnapshotMinOHLCV + */ + 't'?: number; + /** + * The trading volume of the symbol in the given time period. + * @type {number} + * @memberof SnapshotMinOHLCV + */ + 'v'?: number; +} +/** + * + * @export + * @interface SnapshotOHLCV + */ +export interface SnapshotOHLCV { + /** + * The close price for the symbol in the given time period. + * @type {number} + * @memberof SnapshotOHLCV + */ + 'c': number; + /** + * The highest price for the symbol in the given time period. + * @type {number} + * @memberof SnapshotOHLCV + */ + 'h': number; + /** + * The lowest price for the symbol in the given time period. + * @type {number} + * @memberof SnapshotOHLCV + */ + 'l': number; + /** + * The open price for the symbol in the given time period. + * @type {number} + * @memberof SnapshotOHLCV + */ + 'o': number; + /** + * The trading volume of the symbol in the given time period. + * @type {number} + * @memberof SnapshotOHLCV + */ + 'v': number; +} +/** + * + * @export + * @interface SnapshotOHLCVVW + */ +export interface SnapshotOHLCVVW { + /** + * The close price for the symbol in the given time period. + * @type {number} + * @memberof SnapshotOHLCVVW + */ + 'c': number; + /** + * The highest price for the symbol in the given time period. + * @type {number} + * @memberof SnapshotOHLCVVW + */ + 'h': number; + /** + * The lowest price for the symbol in the given time period. + * @type {number} + * @memberof SnapshotOHLCVVW + */ + 'l': number; + /** + * The open price for the symbol in the given time period. + * @type {number} + * @memberof SnapshotOHLCVVW + */ + 'o': number; + /** + * The trading volume of the symbol in the given time period. + * @type {number} + * @memberof SnapshotOHLCVVW + */ + 'v': number; + /** + * The volume weighted average price. + * @type {number} + * @memberof SnapshotOHLCVVW + */ + 'vw': number; +} +/** + * + * @export + * @interface SnapshotOHLCVVWOtc + */ +export interface SnapshotOHLCVVWOtc { + /** + * The close price for the symbol in the given time period. + * @type {number} + * @memberof SnapshotOHLCVVWOtc + */ + 'c': number; + /** + * The highest price for the symbol in the given time period. + * @type {number} + * @memberof SnapshotOHLCVVWOtc + */ + 'h': number; + /** + * The lowest price for the symbol in the given time period. + * @type {number} + * @memberof SnapshotOHLCVVWOtc + */ + 'l': number; + /** + * The open price for the symbol in the given time period. + * @type {number} + * @memberof SnapshotOHLCVVWOtc + */ + 'o': number; + /** + * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. + * @type {boolean} + * @memberof SnapshotOHLCVVWOtc + */ + 'otc'?: boolean; + /** + * The trading volume of the symbol in the given time period. + * @type {number} + * @memberof SnapshotOHLCVVWOtc + */ + 'v': number; + /** + * The volume weighted average price. + * @type {number} + * @memberof SnapshotOHLCVVWOtc + */ + 'vw': number; +} +/** + * + * @export + * @interface StandardBase + */ +export interface StandardBase { + /** + * A request id assigned by the server. + * @type {string} + * @memberof StandardBase + */ + 'request_id': string; + /** + * The total number of results for this request. + * @type {number} + * @memberof StandardBase + */ + 'count'?: number; + /** + * The status of this request\'s response. + * @type {string} + * @memberof StandardBase + */ + 'status': string; +} +/** + * + * @export + * @interface StatusBase + */ +export interface StatusBase { + /** + * The status of this request\'s response. + * @type {string} + * @memberof StatusBase + */ + 'status': string; +} +/** + * + * @export + * @interface StatusCountBase + */ +export interface StatusCountBase { + /** + * The total number of results for this request. + * @type {number} + * @memberof StatusCountBase + */ + 'count'?: number; + /** + * The status of this request\'s response. + * @type {string} + * @memberof StatusCountBase + */ + 'status': string; +} +/** + * + * @export + * @interface StocksGroupedResults + */ +export interface StocksGroupedResults { + /** + * An array of results containing the requested data. + * @type {Array} + * @memberof StocksGroupedResults + */ + 'results'?: Array; +} +/** + * + * @export + * @interface StocksOpenClose + */ +export interface StocksOpenClose { + /** + * The close price of the ticker symbol in after hours trading. + * @type {number} + * @memberof StocksOpenClose + */ + 'afterHours'?: number; + /** + * The close price for the symbol in the given time period. + * @type {number} + * @memberof StocksOpenClose + */ + 'close': number; + /** + * The requested date. + * @type {string} + * @memberof StocksOpenClose + */ + 'from': string; + /** + * The highest price for the symbol in the given time period. + * @type {number} + * @memberof StocksOpenClose + */ + 'high': number; + /** + * The lowest price for the symbol in the given time period. + * @type {number} + * @memberof StocksOpenClose + */ + 'low': number; + /** + * The open price for the symbol in the given time period. + * @type {number} + * @memberof StocksOpenClose + */ + 'open': number; + /** + * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. + * @type {boolean} + * @memberof StocksOpenClose + */ + 'otc'?: boolean; + /** + * The open price of the ticker symbol in pre-market trading. + * @type {number} + * @memberof StocksOpenClose + */ + 'preMarket'?: number; + /** + * The status of this request\'s response. + * @type {string} + * @memberof StocksOpenClose + */ + 'status': string; + /** + * The exchange symbol that this item is traded under. + * @type {string} + * @memberof StocksOpenClose + */ + 'symbol': string; + /** + * The trading volume of the symbol in the given time period. + * @type {number} + * @memberof StocksOpenClose + */ + 'volume': number; +} +/** + * + * @export + * @interface StocksSnapshotLastQuote + */ +export interface StocksSnapshotLastQuote { + /** + * The ask price. + * @type {number} + * @memberof StocksSnapshotLastQuote + */ + 'P': number; + /** + * The ask size in lots. + * @type {number} + * @memberof StocksSnapshotLastQuote + */ + 'S': number; + /** + * The bid price. + * @type {number} + * @memberof StocksSnapshotLastQuote + */ + 'p': number; + /** + * The bid size in lots. + * @type {number} + * @memberof StocksSnapshotLastQuote + */ + 's': number; + /** + * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. + * @type {number} + * @memberof StocksSnapshotLastQuote + */ + 't': number; +} +/** + * + * @export + * @interface StocksSnapshotMinute + */ +export interface StocksSnapshotMinute { + /** + * The accumulated volume. + * @type {number} + * @memberof StocksSnapshotMinute + */ + 'av': number; + /** + * The close price for the symbol in the given time period. + * @type {number} + * @memberof StocksSnapshotMinute + */ + 'c': number; + /** + * The highest price for the symbol in the given time period. + * @type {number} + * @memberof StocksSnapshotMinute + */ + 'h': number; + /** + * The lowest price for the symbol in the given time period. + * @type {number} + * @memberof StocksSnapshotMinute + */ + 'l': number; + /** + * The number of transactions in the aggregate window. + * @type {number} + * @memberof StocksSnapshotMinute + */ + 'n': number; + /** + * The open price for the symbol in the given time period. + * @type {number} + * @memberof StocksSnapshotMinute + */ + 'o': number; + /** + * The Unix millisecond timestamp for the start of the aggregate window. + * @type {number} + * @memberof StocksSnapshotMinute + */ + 't': number; + /** + * The trading volume of the symbol in the given time period. + * @type {number} + * @memberof StocksSnapshotMinute + */ + 'v': number; + /** + * The volume weighted average price. + * @type {number} + * @memberof StocksSnapshotMinute + */ + 'vw': number; +} +/** + * + * @export + * @interface StocksSnapshotMinuteOTC + */ +export interface StocksSnapshotMinuteOTC { + /** + * The accumulated volume. + * @type {number} + * @memberof StocksSnapshotMinuteOTC + */ + 'av': number; + /** + * The close price for the symbol in the given time period. + * @type {number} + * @memberof StocksSnapshotMinuteOTC + */ + 'c': number; + /** + * The highest price for the symbol in the given time period. + * @type {number} + * @memberof StocksSnapshotMinuteOTC + */ + 'h': number; + /** + * The lowest price for the symbol in the given time period. + * @type {number} + * @memberof StocksSnapshotMinuteOTC + */ + 'l': number; + /** + * The number of transactions in the aggregate window. + * @type {number} + * @memberof StocksSnapshotMinuteOTC + */ + 'n': number; + /** + * The open price for the symbol in the given time period. + * @type {number} + * @memberof StocksSnapshotMinuteOTC + */ + 'o': number; + /** + * Whether or not this aggregate is for an OTC ticker. This field will be left off if false. + * @type {boolean} + * @memberof StocksSnapshotMinuteOTC + */ + 'otc'?: boolean; + /** + * The Unix millisecond timestamp for the start of the aggregate window. + * @type {number} + * @memberof StocksSnapshotMinuteOTC + */ + 't': number; + /** + * The trading volume of the symbol in the given time period. + * @type {number} + * @memberof StocksSnapshotMinuteOTC + */ + 'v': number; + /** + * The volume weighted average price. + * @type {number} + * @memberof StocksSnapshotMinuteOTC + */ + 'vw': number; +} +/** + * + * @export + * @interface StocksSnapshotTicker + */ +export interface StocksSnapshotTicker { + /** + * + * @type {GetStocksSnapshotTicker200ResponseAllOfTicker} + * @memberof StocksSnapshotTicker + */ + 'ticker'?: GetStocksSnapshotTicker200ResponseAllOfTicker; +} +/** + * + * @export + * @interface StocksSnapshotTickers + */ +export interface StocksSnapshotTickers { + /** + * An array of snapshot data for the specified tickers. + * @type {Array} + * @memberof StocksSnapshotTickers + */ + 'tickers'?: Array; +} +/** + * + * @export + * @interface StocksTickerResultsOTC + */ +export interface StocksTickerResultsOTC { + /** + * An array of results containing the requested data. + * @type {Array} + * @memberof StocksTickerResultsOTC + */ + 'results'?: Array; +} +/** + * + * @export + * @interface StocksV2Base + */ +export interface StocksV2Base { + /** + * The exchange symbol that this item is traded under. + * @type {string} + * @memberof StocksV2Base + */ + 'T': string; + /** + * The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message. + * @type {number} + * @memberof StocksV2Base + */ + 'f': number; + /** + * The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). + * @type {number} + * @memberof StocksV2Base + */ + 'q': number; + /** + * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. + * @type {number} + * @memberof StocksV2Base + */ + 't': number; + /** + * The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange. + * @type {number} + * @memberof StocksV2Base + */ + 'y': number; +} +/** + * + * @export + * @interface StocksV2NBBO + */ +export interface StocksV2NBBO { + /** + * The exchange symbol that this item is traded under. + * @type {string} + * @memberof StocksV2NBBO + */ + 'T': string; + /** + * The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message. + * @type {number} + * @memberof StocksV2NBBO + */ + 'f': number; + /** + * The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). + * @type {number} + * @memberof StocksV2NBBO + */ + 'q': number; + /** + * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. + * @type {number} + * @memberof StocksV2NBBO + */ + 't': number; + /** + * The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange. + * @type {number} + * @memberof StocksV2NBBO + */ + 'y': number; + /** + * The ask price. + * @type {number} + * @memberof StocksV2NBBO + */ + 'P': number; + /** + * The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price. + * @type {number} + * @memberof StocksV2NBBO + */ + 'S': number; + /** + * The ask exchange ID. See Exchanges for Massive.com\'s mapping of exchange IDs. + * @type {number} + * @memberof StocksV2NBBO + */ + 'X': number; + /** + * A list of condition codes. + * @type {Array} + * @memberof StocksV2NBBO + */ + 'c': Array; + /** + * The indicators. For more information, see our glossary of [Conditions and Indicators](https://massive.com/glossary/us/stocks/conditions-indicators). + * @type {Array} + * @memberof StocksV2NBBO + */ + 'i': Array; + /** + * The bid price. + * @type {number} + * @memberof StocksV2NBBO + */ + 'p': number; + /** + * The bid size. This represents the number of round lot orders at the given bid price. The normal round lot size is 100 shares. A bid size of 2 means there are 200 shares for purchase at the given bid price. + * @type {number} + * @memberof StocksV2NBBO + */ + 's': number; + /** + * The bid exchange ID. See Exchanges for Massive.com\'s mapping of exchange IDs. + * @type {number} + * @memberof StocksV2NBBO + */ + 'x': number; + /** + * There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C. * Tape A is NYSE listed securities * Tape B is NYSE ARCA / NYSE American * Tape C is NASDAQ + * @type {number} + * @memberof StocksV2NBBO + */ + 'z': number; +} +/** + * + * @export + * @interface StocksV2NBBOs + */ +export interface StocksV2NBBOs { + /** + * + * @type {Array} + * @memberof StocksV2NBBOs + */ + 'results'?: Array; +} +/** + * + * @export + * @interface StocksV2Trade + */ +export interface StocksV2Trade { + /** + * The exchange symbol that this item is traded under. + * @type {string} + * @memberof StocksV2Trade + */ + 'T': string; + /** + * The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message. + * @type {number} + * @memberof StocksV2Trade + */ + 'f': number; + /** + * The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11). + * @type {number} + * @memberof StocksV2Trade + */ + 'q': number; + /** + * The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it. + * @type {number} + * @memberof StocksV2Trade + */ + 't': number; + /** + * The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange. + * @type {number} + * @memberof StocksV2Trade + */ + 'y': number; + /** + * A list of condition codes. + * @type {Array} + * @memberof StocksV2Trade + */ + 'c': Array; + /** + * The trade correction indicator. + * @type {number} + * @memberof StocksV2Trade + */ + 'e': number; + /** + * The Trade ID which uniquely identifies a trade. These are unique per combination of ticker, exchange, and TRF. For example: A trade for AAPL executed on NYSE and a trade for AAPL executed on NASDAQ could potentially have the same Trade ID. + * @type {string} + * @memberof StocksV2Trade + */ + 'i': string; + /** + * The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00. + * @type {number} + * @memberof StocksV2Trade + */ + 'p': number; + /** + * The ID for the Trade Reporting Facility where the trade took place. + * @type {number} + * @memberof StocksV2Trade + */ + 'r': number; + /** + * The size of a trade (also known as volume). + * @type {number} + * @memberof StocksV2Trade + */ + 's': number; + /** + * The exchange ID. See Exchanges for Massive.com\'s mapping of exchange IDs. + * @type {number} + * @memberof StocksV2Trade + */ + 'x': number; + /** + * There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C. * Tape A is NYSE listed securities * Tape B is NYSE ARCA / NYSE American * Tape C is NASDAQ + * @type {number} + * @memberof StocksV2Trade + */ + 'z': number; +} +/** + * + * @export + * @interface StocksV2Trades + */ +export interface StocksV2Trades { + /** + * + * @type {Array} + * @memberof StocksV2Trades + */ + 'results'?: Array; +} +/** + * + * @export + * @interface TickerBase + */ +export interface TickerBase { + /** + * The exchange symbol that this item is traded under. + * @type {string} + * @memberof TickerBase + */ + 'ticker': string; +} +/** + * + * @export + * @interface TickerResults + */ +export interface TickerResults { + /** + * An array of results containing the requested data. + * @type {Array} + * @memberof TickerResults + */ + 'results'?: Array; +} +/** + * + * @export + * @interface TradeDetailsMapItem + */ +export interface TradeDetailsMapItem { + /** + * Name of the trade detail item + * @type {string} + * @memberof TradeDetailsMapItem + */ + 'name'?: string; + /** + * Actual type of the trade detail item + * @type {string} + * @memberof TradeDetailsMapItem + */ + 'type'?: string; +} +/** + * + * @export + * @interface V1LastBase + */ +export interface V1LastBase { + /** + * A request id assigned by the server. + * @type {string} + * @memberof V1LastBase + */ + 'request_id': string; + /** + * The status of this request\'s response. + * @type {string} + * @memberof V1LastBase + */ + 'status': string; + /** + * The exchange symbol that this item is traded under. + * @type {string} + * @memberof V1LastBase + */ + 'symbol': string; +} +/** + * + * @export + * @interface V2AggsBase + */ +export interface V2AggsBase { + /** + * Whether or not this response was adjusted for splits. + * @type {boolean} + * @memberof V2AggsBase + */ + 'adjusted': boolean; + /** + * The number of aggregates (minute or day) used to generate the response. + * @type {number} + * @memberof V2AggsBase + */ + 'queryCount': number; + /** + * A request id assigned by the server. + * @type {string} + * @memberof V2AggsBase + */ + 'request_id': string; + /** + * The total number of results for this request. + * @type {number} + * @memberof V2AggsBase + */ + 'resultsCount': number; + /** + * The status of this request\'s response. + * @type {string} + * @memberof V2AggsBase + */ + 'status': string; +} +/** + * + * @export + * @interface V2LastBase + */ +export interface V2LastBase { + /** + * A request id assigned by the server. + * @type {string} + * @memberof V2LastBase + */ + 'request_id': string; + /** + * The status of this request\'s response. + * @type {string} + * @memberof V2LastBase + */ + 'status': string; +} +/** + * + * @export + * @interface V2TicksBase + */ +export interface V2TicksBase { + /** + * Latency in milliseconds for the query results from the database. + * @type {number} + * @memberof V2TicksBase + */ + 'db_latency'?: number; + /** + * The total number of results for this request. + * @type {number} + * @memberof V2TicksBase + */ + 'results_count'?: number; + /** + * Whether or not this query was executed successfully. + * @type {boolean} + * @memberof V2TicksBase + */ + 'success'?: boolean; + /** + * The exchange symbol that this item is traded under. + * @type {string} + * @memberof V2TicksBase + */ + 'ticker'?: string; +} + +/** + * DefaultApi - axios parameter creator + * @export + */ +export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Get the current level 2 book of a single ticker. This is the combined book from all of the exchanges.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. + * @summary Ticker Full Book (L2) + * @param {string} ticker The cryptocurrency ticker. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deprecatedGetCryptoSnapshotTickerBook: async (ticker: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'ticker' is not null or undefined + assertParamExists('deprecatedGetCryptoSnapshotTickerBook', 'ticker', ticker) + const localVarPath = `/v2/snapshot/locale/global/markets/crypto/tickers/{ticker}/book` + .replace(`{${"ticker"}}`, encodeURIComponent(String(ticker))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get historic trade ticks for a cryptocurrency pair. + * @summary Historic Crypto Trades + * @param {string} from The \"from\" symbol of the crypto pair. + * @param {string} to The \"to\" symbol of the crypto pair. + * @param {string} date The date/day of the historic ticks to retrieve. + * @param {number} [offset] The timestamp offset, used for pagination. This is the offset at which to start the results. Using the `timestamp` of the last result as the offset will give you the next page of results. + * @param {number} [limit] Limit the size of the response, max 10000. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deprecatedGetHistoricCryptoTrades: async (from: string, to: string, date: string, offset?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'from' is not null or undefined + assertParamExists('deprecatedGetHistoricCryptoTrades', 'from', from) + // verify required parameter 'to' is not null or undefined + assertParamExists('deprecatedGetHistoricCryptoTrades', 'to', to) + // verify required parameter 'date' is not null or undefined + assertParamExists('deprecatedGetHistoricCryptoTrades', 'date', date) + const localVarPath = `/v1/historic/crypto/{from}/{to}/{date}` + .replace(`{${"from"}}`, encodeURIComponent(String(from))) + .replace(`{${"to"}}`, encodeURIComponent(String(to))) + .replace(`{${"date"}}`, encodeURIComponent(String(date))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get historic ticks for a forex currency pair. + * @summary Historic Forex Ticks + * @param {string} from The \"from\" symbol of the currency pair. Example: For **USD/JPY** the `from` would be **USD**. + * @param {string} to The \"to\" symbol of the currency pair. Example: For **USD/JPY** the `to` would be **JPY**. + * @param {string} date The date/day of the historic ticks to retrieve. + * @param {number} [offset] The timestamp offset, used for pagination. This is the offset at which to start the results. Using the `timestamp` of the last result as the offset will give you the next page of results. + * @param {number} [limit] Limit the size of the response, max 10000. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deprecatedGetHistoricForexQuotes: async (from: string, to: string, date: string, offset?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'from' is not null or undefined + assertParamExists('deprecatedGetHistoricForexQuotes', 'from', from) + // verify required parameter 'to' is not null or undefined + assertParamExists('deprecatedGetHistoricForexQuotes', 'to', to) + // verify required parameter 'date' is not null or undefined + assertParamExists('deprecatedGetHistoricForexQuotes', 'date', date) + const localVarPath = `/v1/historic/forex/{from}/{to}/{date}` + .replace(`{${"from"}}`, encodeURIComponent(String(from))) + .replace(`{${"to"}}`, encodeURIComponent(String(to))) + .replace(`{${"date"}}`, encodeURIComponent(String(date))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get NBBO quotes for a given ticker symbol on a specified date. + * @summary Quotes (NBBO) + * @param {string} ticker The ticker symbol we want quotes for. + * @param {string} date The date/day of the quotes to retrieve in the format YYYY-MM-DD. + * @param {number} [timestamp] The timestamp offset, used for pagination. This is the offset at which to start the results. Using the `timestamp` of the last result as the offset will give you the next page of results. + * @param {number} [timestampLimit] The maximum timestamp allowed in the results. + * @param {boolean} [reverse] Reverse the order of the results. + * @param {number} [limit] Limit the size of the response, max 50000 and default 5000. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deprecatedGetHistoricStocksQuotes: async (ticker: string, date: string, timestamp?: number, timestampLimit?: number, reverse?: boolean, limit?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'ticker' is not null or undefined + assertParamExists('deprecatedGetHistoricStocksQuotes', 'ticker', ticker) + // verify required parameter 'date' is not null or undefined + assertParamExists('deprecatedGetHistoricStocksQuotes', 'date', date) + const localVarPath = `/v2/ticks/stocks/nbbo/{ticker}/{date}` + .replace(`{${"ticker"}}`, encodeURIComponent(String(ticker))) + .replace(`{${"date"}}`, encodeURIComponent(String(date))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + if (timestamp !== undefined) { + localVarQueryParameter['timestamp'] = timestamp; + } + + if (timestampLimit !== undefined) { + localVarQueryParameter['timestampLimit'] = timestampLimit; + } + + if (reverse !== undefined) { + localVarQueryParameter['reverse'] = reverse; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get trades for a given ticker symbol on a specified date. + * @summary Trades + * @param {string} ticker The ticker symbol we want trades for. + * @param {string} date The date/day of the trades to retrieve in the format YYYY-MM-DD. + * @param {number} [timestamp] The timestamp offset, used for pagination. This is the offset at which to start the results. Using the `timestamp` of the last result as the offset will give you the next page of results. + * @param {number} [timestampLimit] The maximum timestamp allowed in the results. + * @param {boolean} [reverse] Reverse the order of the results. + * @param {number} [limit] Limit the size of the response, max 50000 and default 5000. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deprecatedGetHistoricStocksTrades: async (ticker: string, date: string, timestamp?: number, timestampLimit?: number, reverse?: boolean, limit?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'ticker' is not null or undefined + assertParamExists('deprecatedGetHistoricStocksTrades', 'ticker', ticker) + // verify required parameter 'date' is not null or undefined + assertParamExists('deprecatedGetHistoricStocksTrades', 'date', date) + const localVarPath = `/v2/ticks/stocks/trades/{ticker}/{date}` + .replace(`{${"ticker"}}`, encodeURIComponent(String(ticker))) + .replace(`{${"date"}}`, encodeURIComponent(String(date))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + if (timestamp !== undefined) { + localVarQueryParameter['timestamp'] = timestamp; + } + + if (timestampLimit !== undefined) { + localVarQueryParameter['timestampLimit'] = timestampLimit; + } + + if (reverse !== undefined) { + localVarQueryParameter['reverse'] = reverse; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * A comprehensive database of financial analyst insights and ratings for various publicly traded companies, capturing detailed information about analyst recommendations and price targets. + * @param {string} [date] The calendar date (formatted as YYYY-MM-DD) when the rating was issued. + * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [dateGt] Filter greater than the value. + * @param {string} [dateGte] Filter greater than or equal to the value. + * @param {string} [dateLt] Filter less than the value. + * @param {string} [dateLte] Filter less than or equal to the value. + * @param {string} [ticker] The stock symbol of the company being rated. + * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickerGt] Filter greater than the value. + * @param {string} [tickerGte] Filter greater than or equal to the value. + * @param {string} [tickerLt] Filter less than the value. + * @param {string} [tickerLte] Filter less than or equal to the value. + * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system. + * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [lastUpdatedGt] Filter greater than the value. + * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. + * @param {string} [lastUpdatedLt] Filter less than the value. + * @param {string} [lastUpdatedLte] Filter less than or equal to the value. + * @param {string} [firm] The name of the research firm or investment bank issuing the rating. + * @param {string} [firmAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [firmGt] Filter greater than the value. + * @param {string} [firmGte] Filter greater than or equal to the value. + * @param {string} [firmLt] Filter less than the value. + * @param {string} [firmLte] Filter less than or equal to the value. + * @param {string} [ratingAction] The description of the change in rating from the firm\'s last rating. Possible values include: downgrades, maintains, reinstates, reiterates, upgrades, assumes, initiates_coverage_on, terminates_coverage_on, removes, suspends, firm_dissolved. + * @param {string} [ratingActionAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [ratingActionGt] Filter greater than the value. + * @param {string} [ratingActionGte] Filter greater than or equal to the value. + * @param {string} [ratingActionLt] Filter less than the value. + * @param {string} [ratingActionLte] Filter less than or equal to the value. + * @param {string} [benzingaFirmId] The identifer used by Benzinga for the firm record. + * @param {string} [benzingaFirmIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [benzingaFirmIdGt] Filter greater than the value. + * @param {string} [benzingaFirmIdGte] Filter greater than or equal to the value. + * @param {string} [benzingaFirmIdLt] Filter less than the value. + * @param {string} [benzingaFirmIdLte] Filter less than or equal to the value. + * @param {string} [benzingaRatingId] The identifier used by Benzinga for the rating record. + * @param {string} [benzingaRatingIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [benzingaRatingIdGt] Filter greater than the value. + * @param {string} [benzingaRatingIdGte] Filter greater than or equal to the value. + * @param {string} [benzingaRatingIdLt] Filter less than the value. + * @param {string} [benzingaRatingIdLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getBenzingaV1AnalystInsights: async (date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, firm?: string, firmAnyOf?: string, firmGt?: string, firmGte?: string, firmLt?: string, firmLte?: string, ratingAction?: string, ratingActionAnyOf?: string, ratingActionGt?: string, ratingActionGte?: string, ratingActionLt?: string, ratingActionLte?: string, benzingaFirmId?: string, benzingaFirmIdAnyOf?: string, benzingaFirmIdGt?: string, benzingaFirmIdGte?: string, benzingaFirmIdLt?: string, benzingaFirmIdLte?: string, benzingaRatingId?: string, benzingaRatingIdAnyOf?: string, benzingaRatingIdGt?: string, benzingaRatingIdGte?: string, benzingaRatingIdLt?: string, benzingaRatingIdLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/benzinga/v1/analyst-insights`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + if (date !== undefined) { + localVarQueryParameter['date'] = date; + } + + if (dateAnyOf !== undefined) { + localVarQueryParameter['date.any_of'] = dateAnyOf; + } + + if (dateGt !== undefined) { + localVarQueryParameter['date.gt'] = dateGt; + } + + if (dateGte !== undefined) { + localVarQueryParameter['date.gte'] = dateGte; + } + + if (dateLt !== undefined) { + localVarQueryParameter['date.lt'] = dateLt; + } + + if (dateLte !== undefined) { + localVarQueryParameter['date.lte'] = dateLte; + } + + if (ticker !== undefined) { + localVarQueryParameter['ticker'] = ticker; + } + + if (tickerAnyOf !== undefined) { + localVarQueryParameter['ticker.any_of'] = tickerAnyOf; + } + + if (tickerGt !== undefined) { + localVarQueryParameter['ticker.gt'] = tickerGt; + } + + if (tickerGte !== undefined) { + localVarQueryParameter['ticker.gte'] = tickerGte; + } + + if (tickerLt !== undefined) { + localVarQueryParameter['ticker.lt'] = tickerLt; + } + + if (tickerLte !== undefined) { + localVarQueryParameter['ticker.lte'] = tickerLte; + } + + if (lastUpdated !== undefined) { + localVarQueryParameter['last_updated'] = lastUpdated; + } + + if (lastUpdatedAnyOf !== undefined) { + localVarQueryParameter['last_updated.any_of'] = lastUpdatedAnyOf; + } + + if (lastUpdatedGt !== undefined) { + localVarQueryParameter['last_updated.gt'] = lastUpdatedGt; + } + + if (lastUpdatedGte !== undefined) { + localVarQueryParameter['last_updated.gte'] = lastUpdatedGte; + } + + if (lastUpdatedLt !== undefined) { + localVarQueryParameter['last_updated.lt'] = lastUpdatedLt; + } + + if (lastUpdatedLte !== undefined) { + localVarQueryParameter['last_updated.lte'] = lastUpdatedLte; + } + + if (firm !== undefined) { + localVarQueryParameter['firm'] = firm; + } + + if (firmAnyOf !== undefined) { + localVarQueryParameter['firm.any_of'] = firmAnyOf; + } + + if (firmGt !== undefined) { + localVarQueryParameter['firm.gt'] = firmGt; + } + + if (firmGte !== undefined) { + localVarQueryParameter['firm.gte'] = firmGte; + } + + if (firmLt !== undefined) { + localVarQueryParameter['firm.lt'] = firmLt; + } + + if (firmLte !== undefined) { + localVarQueryParameter['firm.lte'] = firmLte; + } + + if (ratingAction !== undefined) { + localVarQueryParameter['rating_action'] = ratingAction; + } + + if (ratingActionAnyOf !== undefined) { + localVarQueryParameter['rating_action.any_of'] = ratingActionAnyOf; + } + + if (ratingActionGt !== undefined) { + localVarQueryParameter['rating_action.gt'] = ratingActionGt; + } + + if (ratingActionGte !== undefined) { + localVarQueryParameter['rating_action.gte'] = ratingActionGte; + } + + if (ratingActionLt !== undefined) { + localVarQueryParameter['rating_action.lt'] = ratingActionLt; + } + + if (ratingActionLte !== undefined) { + localVarQueryParameter['rating_action.lte'] = ratingActionLte; + } + + if (benzingaFirmId !== undefined) { + localVarQueryParameter['benzinga_firm_id'] = benzingaFirmId; + } + + if (benzingaFirmIdAnyOf !== undefined) { + localVarQueryParameter['benzinga_firm_id.any_of'] = benzingaFirmIdAnyOf; + } + + if (benzingaFirmIdGt !== undefined) { + localVarQueryParameter['benzinga_firm_id.gt'] = benzingaFirmIdGt; + } + + if (benzingaFirmIdGte !== undefined) { + localVarQueryParameter['benzinga_firm_id.gte'] = benzingaFirmIdGte; + } + + if (benzingaFirmIdLt !== undefined) { + localVarQueryParameter['benzinga_firm_id.lt'] = benzingaFirmIdLt; + } + + if (benzingaFirmIdLte !== undefined) { + localVarQueryParameter['benzinga_firm_id.lte'] = benzingaFirmIdLte; + } + + if (benzingaRatingId !== undefined) { + localVarQueryParameter['benzinga_rating_id'] = benzingaRatingId; + } + + if (benzingaRatingIdAnyOf !== undefined) { + localVarQueryParameter['benzinga_rating_id.any_of'] = benzingaRatingIdAnyOf; + } + + if (benzingaRatingIdGt !== undefined) { + localVarQueryParameter['benzinga_rating_id.gt'] = benzingaRatingIdGt; + } + + if (benzingaRatingIdGte !== undefined) { + localVarQueryParameter['benzinga_rating_id.gte'] = benzingaRatingIdGte; + } + + if (benzingaRatingIdLt !== undefined) { + localVarQueryParameter['benzinga_rating_id.lt'] = benzingaRatingIdLt; + } + + if (benzingaRatingIdLte !== undefined) { + localVarQueryParameter['benzinga_rating_id.lte'] = benzingaRatingIdLte; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * A comprehensive database of financial analysts, containing detailed performance metrics and identification information for individual analysts across various financial firms. + * @param {string} [benzingaId] The identifier used by Benzinga for this record. + * @param {string} [benzingaIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [benzingaIdGt] Filter greater than the value. + * @param {string} [benzingaIdGte] Filter greater than or equal to the value. + * @param {string} [benzingaIdLt] Filter less than the value. + * @param {string} [benzingaIdLte] Filter less than or equal to the value. + * @param {string} [benzingaFirmId] The unique identifier assigned by Benzinga to the research firm or investment bank. + * @param {string} [benzingaFirmIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [benzingaFirmIdGt] Filter greater than the value. + * @param {string} [benzingaFirmIdGte] Filter greater than or equal to the value. + * @param {string} [benzingaFirmIdLt] Filter less than the value. + * @param {string} [benzingaFirmIdLte] Filter less than or equal to the value. + * @param {string} [firmName] The name of the research firm or investment bank issuing the ratings. + * @param {string} [firmNameAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [firmNameGt] Filter greater than the value. + * @param {string} [firmNameGte] Filter greater than or equal to the value. + * @param {string} [firmNameLt] Filter less than the value. + * @param {string} [firmNameLte] Filter less than or equal to the value. + * @param {string} [fullName] The full name of the analyst associated with the ratings. + * @param {string} [fullNameAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [fullNameGt] Filter greater than the value. + * @param {string} [fullNameGte] Filter greater than or equal to the value. + * @param {string} [fullNameLt] Filter less than the value. + * @param {string} [fullNameLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'full_name\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getBenzingaV1Analysts: async (benzingaId?: string, benzingaIdAnyOf?: string, benzingaIdGt?: string, benzingaIdGte?: string, benzingaIdLt?: string, benzingaIdLte?: string, benzingaFirmId?: string, benzingaFirmIdAnyOf?: string, benzingaFirmIdGt?: string, benzingaFirmIdGte?: string, benzingaFirmIdLt?: string, benzingaFirmIdLte?: string, firmName?: string, firmNameAnyOf?: string, firmNameGt?: string, firmNameGte?: string, firmNameLt?: string, firmNameLte?: string, fullName?: string, fullNameAnyOf?: string, fullNameGt?: string, fullNameGte?: string, fullNameLt?: string, fullNameLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/benzinga/v1/analysts`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + if (benzingaId !== undefined) { + localVarQueryParameter['benzinga_id'] = benzingaId; + } + + if (benzingaIdAnyOf !== undefined) { + localVarQueryParameter['benzinga_id.any_of'] = benzingaIdAnyOf; + } + + if (benzingaIdGt !== undefined) { + localVarQueryParameter['benzinga_id.gt'] = benzingaIdGt; + } + + if (benzingaIdGte !== undefined) { + localVarQueryParameter['benzinga_id.gte'] = benzingaIdGte; + } + + if (benzingaIdLt !== undefined) { + localVarQueryParameter['benzinga_id.lt'] = benzingaIdLt; + } + + if (benzingaIdLte !== undefined) { + localVarQueryParameter['benzinga_id.lte'] = benzingaIdLte; + } + + if (benzingaFirmId !== undefined) { + localVarQueryParameter['benzinga_firm_id'] = benzingaFirmId; + } + + if (benzingaFirmIdAnyOf !== undefined) { + localVarQueryParameter['benzinga_firm_id.any_of'] = benzingaFirmIdAnyOf; + } + + if (benzingaFirmIdGt !== undefined) { + localVarQueryParameter['benzinga_firm_id.gt'] = benzingaFirmIdGt; + } + + if (benzingaFirmIdGte !== undefined) { + localVarQueryParameter['benzinga_firm_id.gte'] = benzingaFirmIdGte; + } + + if (benzingaFirmIdLt !== undefined) { + localVarQueryParameter['benzinga_firm_id.lt'] = benzingaFirmIdLt; + } + + if (benzingaFirmIdLte !== undefined) { + localVarQueryParameter['benzinga_firm_id.lte'] = benzingaFirmIdLte; + } + + if (firmName !== undefined) { + localVarQueryParameter['firm_name'] = firmName; + } + + if (firmNameAnyOf !== undefined) { + localVarQueryParameter['firm_name.any_of'] = firmNameAnyOf; + } + + if (firmNameGt !== undefined) { + localVarQueryParameter['firm_name.gt'] = firmNameGt; + } + + if (firmNameGte !== undefined) { + localVarQueryParameter['firm_name.gte'] = firmNameGte; + } + + if (firmNameLt !== undefined) { + localVarQueryParameter['firm_name.lt'] = firmNameLt; + } + + if (firmNameLte !== undefined) { + localVarQueryParameter['firm_name.lte'] = firmNameLte; + } + + if (fullName !== undefined) { + localVarQueryParameter['full_name'] = fullName; + } + + if (fullNameAnyOf !== undefined) { + localVarQueryParameter['full_name.any_of'] = fullNameAnyOf; + } + + if (fullNameGt !== undefined) { + localVarQueryParameter['full_name.gt'] = fullNameGt; + } + + if (fullNameGte !== undefined) { + localVarQueryParameter['full_name.gte'] = fullNameGte; + } + + if (fullNameLt !== undefined) { + localVarQueryParameter['full_name.lt'] = fullNameLt; + } + + if (fullNameLte !== undefined) { + localVarQueryParameter['full_name.lte'] = fullNameLte; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * A comprehensive financial consensus ratings table that aggregates analyst recommendations and price targets for individual stock tickers, capturing detailed rating breakdowns and statistical insights. + * @param {string} ticker The requested ticker. + * @param {string} [date] The publication date of the news article. + * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [dateGt] Filter greater than the value. + * @param {string} [dateGte] Filter greater than or equal to the value. + * @param {string} [dateLt] Filter less than the value. + * @param {string} [dateLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getBenzingaV1ConsensusRatings: async (ticker: string, date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'ticker' is not null or undefined + assertParamExists('getBenzingaV1ConsensusRatings', 'ticker', ticker) + const localVarPath = `/benzinga/v1/consensus-ratings/{ticker}` + .replace(`{${"ticker"}}`, encodeURIComponent(String(ticker))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + if (date !== undefined) { + localVarQueryParameter['date'] = date; + } + + if (dateAnyOf !== undefined) { + localVarQueryParameter['date.any_of'] = dateAnyOf; + } + + if (dateGt !== undefined) { + localVarQueryParameter['date.gt'] = dateGt; + } + + if (dateGte !== undefined) { + localVarQueryParameter['date.gte'] = dateGte; + } + + if (dateLt !== undefined) { + localVarQueryParameter['date.lt'] = dateLt; + } + + if (dateLte !== undefined) { + localVarQueryParameter['date.lte'] = dateLte; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * This table contains earnings data from Benzinga, tracking both actual and estimated financial metrics for publicly traded companies. It includes EPS and revenue figures with surprise calculations, along with metadata like fiscal periods, company identifiers, and reporting timestamps. + * @param {string} [date] The calendar date (formatted as YYYY-MM-DD) when the earnings are scheduled or were reported. + * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [dateGt] Filter greater than the value. + * @param {string} [dateGte] Filter greater than or equal to the value. + * @param {string} [dateLt] Filter less than the value. + * @param {string} [dateLte] Filter less than or equal to the value. + * @param {string} [ticker] The stock symbol of the company reporting earnings. + * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickerGt] Filter greater than the value. + * @param {string} [tickerGte] Filter greater than or equal to the value. + * @param {string} [tickerLt] Filter less than the value. + * @param {string} [tickerLte] Filter less than or equal to the value. + * @param {number} [importance] A subjective indicator of the importance of the event, on a scale from 0 (lowest) to 5 (highest). Value must be an integer. + * @param {string} [importanceAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. + * @param {number} [importanceGt] Filter greater than the value. Value must be an integer. + * @param {number} [importanceGte] Filter greater than or equal to the value. Value must be an integer. + * @param {number} [importanceLt] Filter less than the value. Value must be an integer. + * @param {number} [importanceLte] Filter less than or equal to the value. Value must be an integer. + * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedGt] Filter greater than the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedLt] Filter less than the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedLte] Filter less than or equal to the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [dateStatus] Indicates whether the date of the earnings report has been confirmed. Possible values include: projected, confirmed. + * @param {string} [dateStatusAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [dateStatusGt] Filter greater than the value. + * @param {string} [dateStatusGte] Filter greater than or equal to the value. + * @param {string} [dateStatusLt] Filter less than the value. + * @param {string} [dateStatusLte] Filter less than or equal to the value. + * @param {number} [epsSurprisePercent] The percentage difference between the actual and estimated EPS. Value must be a floating point number. + * @param {string} [epsSurprisePercentAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number. + * @param {number} [epsSurprisePercentGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [epsSurprisePercentGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [epsSurprisePercentLt] Filter less than the value. Value must be a floating point number. + * @param {number} [epsSurprisePercentLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [revenueSurprisePercent] The percentage difference between the actual and estimated revenue. Value must be a floating point number. + * @param {string} [revenueSurprisePercentAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number. + * @param {number} [revenueSurprisePercentGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [revenueSurprisePercentGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [revenueSurprisePercentLt] Filter less than the value. Value must be a floating point number. + * @param {number} [revenueSurprisePercentLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalYear] The fiscal year in which the earnings period falls. Value must be an integer. + * @param {string} [fiscalYearAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. + * @param {number} [fiscalYearGt] Filter greater than the value. Value must be an integer. + * @param {number} [fiscalYearGte] Filter greater than or equal to the value. Value must be an integer. + * @param {number} [fiscalYearLt] Filter less than the value. Value must be an integer. + * @param {number} [fiscalYearLte] Filter less than or equal to the value. Value must be an integer. + * @param {string} [fiscalPeriod] The fiscal period for which the earnings are reported. Examples include: Q1, Q2, H1, FY. + * @param {string} [fiscalPeriodAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [fiscalPeriodGt] Filter greater than the value. + * @param {string} [fiscalPeriodGte] Filter greater than or equal to the value. + * @param {string} [fiscalPeriodLt] Filter less than the value. + * @param {string} [fiscalPeriodLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'last_updated\' if not specified. The sort order defaults to \'desc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getBenzingaV1Earnings: async (date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, importance?: number, importanceAnyOf?: string, importanceGt?: number, importanceGte?: number, importanceLt?: number, importanceLte?: number, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, dateStatus?: string, dateStatusAnyOf?: string, dateStatusGt?: string, dateStatusGte?: string, dateStatusLt?: string, dateStatusLte?: string, epsSurprisePercent?: number, epsSurprisePercentAnyOf?: string, epsSurprisePercentGt?: number, epsSurprisePercentGte?: number, epsSurprisePercentLt?: number, epsSurprisePercentLte?: number, revenueSurprisePercent?: number, revenueSurprisePercentAnyOf?: string, revenueSurprisePercentGt?: number, revenueSurprisePercentGte?: number, revenueSurprisePercentLt?: number, revenueSurprisePercentLte?: number, fiscalYear?: number, fiscalYearAnyOf?: string, fiscalYearGt?: number, fiscalYearGte?: number, fiscalYearLt?: number, fiscalYearLte?: number, fiscalPeriod?: string, fiscalPeriodAnyOf?: string, fiscalPeriodGt?: string, fiscalPeriodGte?: string, fiscalPeriodLt?: string, fiscalPeriodLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/benzinga/v1/earnings`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + if (date !== undefined) { + localVarQueryParameter['date'] = date; + } + + if (dateAnyOf !== undefined) { + localVarQueryParameter['date.any_of'] = dateAnyOf; + } + + if (dateGt !== undefined) { + localVarQueryParameter['date.gt'] = dateGt; + } + + if (dateGte !== undefined) { + localVarQueryParameter['date.gte'] = dateGte; + } + + if (dateLt !== undefined) { + localVarQueryParameter['date.lt'] = dateLt; + } + + if (dateLte !== undefined) { + localVarQueryParameter['date.lte'] = dateLte; + } + + if (ticker !== undefined) { + localVarQueryParameter['ticker'] = ticker; + } + + if (tickerAnyOf !== undefined) { + localVarQueryParameter['ticker.any_of'] = tickerAnyOf; + } + + if (tickerGt !== undefined) { + localVarQueryParameter['ticker.gt'] = tickerGt; + } + + if (tickerGte !== undefined) { + localVarQueryParameter['ticker.gte'] = tickerGte; + } + + if (tickerLt !== undefined) { + localVarQueryParameter['ticker.lt'] = tickerLt; + } + + if (tickerLte !== undefined) { + localVarQueryParameter['ticker.lte'] = tickerLte; + } + + if (importance !== undefined) { + localVarQueryParameter['importance'] = importance; + } + + if (importanceAnyOf !== undefined) { + localVarQueryParameter['importance.any_of'] = importanceAnyOf; + } + + if (importanceGt !== undefined) { + localVarQueryParameter['importance.gt'] = importanceGt; + } + + if (importanceGte !== undefined) { + localVarQueryParameter['importance.gte'] = importanceGte; + } + + if (importanceLt !== undefined) { + localVarQueryParameter['importance.lt'] = importanceLt; + } + + if (importanceLte !== undefined) { + localVarQueryParameter['importance.lte'] = importanceLte; + } + + if (lastUpdated !== undefined) { + localVarQueryParameter['last_updated'] = lastUpdated; + } + + if (lastUpdatedAnyOf !== undefined) { + localVarQueryParameter['last_updated.any_of'] = lastUpdatedAnyOf; + } + + if (lastUpdatedGt !== undefined) { + localVarQueryParameter['last_updated.gt'] = lastUpdatedGt; + } + + if (lastUpdatedGte !== undefined) { + localVarQueryParameter['last_updated.gte'] = lastUpdatedGte; + } + + if (lastUpdatedLt !== undefined) { + localVarQueryParameter['last_updated.lt'] = lastUpdatedLt; + } + + if (lastUpdatedLte !== undefined) { + localVarQueryParameter['last_updated.lte'] = lastUpdatedLte; + } + + if (dateStatus !== undefined) { + localVarQueryParameter['date_status'] = dateStatus; + } + + if (dateStatusAnyOf !== undefined) { + localVarQueryParameter['date_status.any_of'] = dateStatusAnyOf; + } + + if (dateStatusGt !== undefined) { + localVarQueryParameter['date_status.gt'] = dateStatusGt; + } + + if (dateStatusGte !== undefined) { + localVarQueryParameter['date_status.gte'] = dateStatusGte; + } + + if (dateStatusLt !== undefined) { + localVarQueryParameter['date_status.lt'] = dateStatusLt; + } + + if (dateStatusLte !== undefined) { + localVarQueryParameter['date_status.lte'] = dateStatusLte; + } + + if (epsSurprisePercent !== undefined) { + localVarQueryParameter['eps_surprise_percent'] = epsSurprisePercent; + } + + if (epsSurprisePercentAnyOf !== undefined) { + localVarQueryParameter['eps_surprise_percent.any_of'] = epsSurprisePercentAnyOf; + } + + if (epsSurprisePercentGt !== undefined) { + localVarQueryParameter['eps_surprise_percent.gt'] = epsSurprisePercentGt; + } + + if (epsSurprisePercentGte !== undefined) { + localVarQueryParameter['eps_surprise_percent.gte'] = epsSurprisePercentGte; + } + + if (epsSurprisePercentLt !== undefined) { + localVarQueryParameter['eps_surprise_percent.lt'] = epsSurprisePercentLt; + } + + if (epsSurprisePercentLte !== undefined) { + localVarQueryParameter['eps_surprise_percent.lte'] = epsSurprisePercentLte; + } + + if (revenueSurprisePercent !== undefined) { + localVarQueryParameter['revenue_surprise_percent'] = revenueSurprisePercent; + } + + if (revenueSurprisePercentAnyOf !== undefined) { + localVarQueryParameter['revenue_surprise_percent.any_of'] = revenueSurprisePercentAnyOf; + } + + if (revenueSurprisePercentGt !== undefined) { + localVarQueryParameter['revenue_surprise_percent.gt'] = revenueSurprisePercentGt; + } + + if (revenueSurprisePercentGte !== undefined) { + localVarQueryParameter['revenue_surprise_percent.gte'] = revenueSurprisePercentGte; + } + + if (revenueSurprisePercentLt !== undefined) { + localVarQueryParameter['revenue_surprise_percent.lt'] = revenueSurprisePercentLt; + } + + if (revenueSurprisePercentLte !== undefined) { + localVarQueryParameter['revenue_surprise_percent.lte'] = revenueSurprisePercentLte; + } + + if (fiscalYear !== undefined) { + localVarQueryParameter['fiscal_year'] = fiscalYear; + } + + if (fiscalYearAnyOf !== undefined) { + localVarQueryParameter['fiscal_year.any_of'] = fiscalYearAnyOf; + } + + if (fiscalYearGt !== undefined) { + localVarQueryParameter['fiscal_year.gt'] = fiscalYearGt; + } + + if (fiscalYearGte !== undefined) { + localVarQueryParameter['fiscal_year.gte'] = fiscalYearGte; + } + + if (fiscalYearLt !== undefined) { + localVarQueryParameter['fiscal_year.lt'] = fiscalYearLt; + } + + if (fiscalYearLte !== undefined) { + localVarQueryParameter['fiscal_year.lte'] = fiscalYearLte; + } + + if (fiscalPeriod !== undefined) { + localVarQueryParameter['fiscal_period'] = fiscalPeriod; + } + + if (fiscalPeriodAnyOf !== undefined) { + localVarQueryParameter['fiscal_period.any_of'] = fiscalPeriodAnyOf; + } + + if (fiscalPeriodGt !== undefined) { + localVarQueryParameter['fiscal_period.gt'] = fiscalPeriodGt; + } + + if (fiscalPeriodGte !== undefined) { + localVarQueryParameter['fiscal_period.gte'] = fiscalPeriodGte; + } + + if (fiscalPeriodLt !== undefined) { + localVarQueryParameter['fiscal_period.lt'] = fiscalPeriodLt; + } + + if (fiscalPeriodLte !== undefined) { + localVarQueryParameter['fiscal_period.lte'] = fiscalPeriodLte; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * A comprehensive database of financial firms, tracking unique identifiers, names, and basic metadata for various financial institutions and research firms. + * @param {string} [benzingaId] The identifer used by Benzinga for this record. + * @param {string} [benzingaIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [benzingaIdGt] Filter greater than the value. + * @param {string} [benzingaIdGte] Filter greater than or equal to the value. + * @param {string} [benzingaIdLt] Filter less than the value. + * @param {string} [benzingaIdLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'name\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getBenzingaV1Firms: async (benzingaId?: string, benzingaIdAnyOf?: string, benzingaIdGt?: string, benzingaIdGte?: string, benzingaIdLt?: string, benzingaIdLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/benzinga/v1/firms`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + if (benzingaId !== undefined) { + localVarQueryParameter['benzinga_id'] = benzingaId; + } + + if (benzingaIdAnyOf !== undefined) { + localVarQueryParameter['benzinga_id.any_of'] = benzingaIdAnyOf; + } + + if (benzingaIdGt !== undefined) { + localVarQueryParameter['benzinga_id.gt'] = benzingaIdGt; + } + + if (benzingaIdGte !== undefined) { + localVarQueryParameter['benzinga_id.gte'] = benzingaIdGte; + } + + if (benzingaIdLt !== undefined) { + localVarQueryParameter['benzinga_id.lt'] = benzingaIdLt; + } + + if (benzingaIdLte !== undefined) { + localVarQueryParameter['benzinga_id.lte'] = benzingaIdLte; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * A comprehensive database of financial guidance and earnings estimates for various companies, capturing key metrics related to earnings per share (EPS) and revenue projections across different fiscal periods. + * @param {string} [date] The calendar date (formatted as YYYY-MM-DD) when the guidance was issued. + * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [dateGt] Filter greater than the value. + * @param {string} [dateGte] Filter greater than or equal to the value. + * @param {string} [dateLt] Filter less than the value. + * @param {string} [dateLte] Filter less than or equal to the value. + * @param {string} [ticker] The stock symbol of the company issuing guidance. + * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickerGt] Filter greater than the value. + * @param {string} [tickerGte] Filter greater than or equal to the value. + * @param {string} [tickerLt] Filter less than the value. + * @param {string} [tickerLte] Filter less than or equal to the value. + * @param {string} [positioning] Indicates how a particular guidance value is presented relative to other figures disclosed by the company. Possible values are \'primary\' (the emphasized figure) and \'secondary\' (a supporting or alternate figure) + * @param {string} [positioningAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [positioningGt] Filter greater than the value. + * @param {string} [positioningGte] Filter greater than or equal to the value. + * @param {string} [positioningLt] Filter less than the value. + * @param {string} [positioningLte] Filter less than or equal to the value. + * @param {number} [importance] A subjective indicator of the importance of the event, on a scale from 0 (lowest) to 5 (highest). Value must be an integer. + * @param {string} [importanceAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. + * @param {number} [importanceGt] Filter greater than the value. Value must be an integer. + * @param {number} [importanceGte] Filter greater than or equal to the value. Value must be an integer. + * @param {number} [importanceLt] Filter less than the value. Value must be an integer. + * @param {number} [importanceLte] Filter less than or equal to the value. Value must be an integer. + * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system. + * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [lastUpdatedGt] Filter greater than the value. + * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. + * @param {string} [lastUpdatedLt] Filter less than the value. + * @param {string} [lastUpdatedLte] Filter less than or equal to the value. + * @param {number} [fiscalYear] The fiscal year corresponding to the period for which the guidance is issued. Value must be an integer. + * @param {string} [fiscalYearAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. + * @param {number} [fiscalYearGt] Filter greater than the value. Value must be an integer. + * @param {number} [fiscalYearGte] Filter greater than or equal to the value. Value must be an integer. + * @param {number} [fiscalYearLt] Filter less than the value. Value must be an integer. + * @param {number} [fiscalYearLte] Filter less than or equal to the value. Value must be an integer. + * @param {string} [fiscalPeriod] The fiscal quarter to which the guidance applies, such as Q1, Q2, Q3, or Q4. + * @param {string} [fiscalPeriodAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [fiscalPeriodGt] Filter greater than the value. + * @param {string} [fiscalPeriodGte] Filter greater than or equal to the value. + * @param {string} [fiscalPeriodLt] Filter less than the value. + * @param {string} [fiscalPeriodLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getBenzingaV1Guidance: async (date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, positioning?: string, positioningAnyOf?: string, positioningGt?: string, positioningGte?: string, positioningLt?: string, positioningLte?: string, importance?: number, importanceAnyOf?: string, importanceGt?: number, importanceGte?: number, importanceLt?: number, importanceLte?: number, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, fiscalYear?: number, fiscalYearAnyOf?: string, fiscalYearGt?: number, fiscalYearGte?: number, fiscalYearLt?: number, fiscalYearLte?: number, fiscalPeriod?: string, fiscalPeriodAnyOf?: string, fiscalPeriodGt?: string, fiscalPeriodGte?: string, fiscalPeriodLt?: string, fiscalPeriodLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/benzinga/v1/guidance`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + if (date !== undefined) { + localVarQueryParameter['date'] = date; + } + + if (dateAnyOf !== undefined) { + localVarQueryParameter['date.any_of'] = dateAnyOf; + } + + if (dateGt !== undefined) { + localVarQueryParameter['date.gt'] = dateGt; + } + + if (dateGte !== undefined) { + localVarQueryParameter['date.gte'] = dateGte; + } + + if (dateLt !== undefined) { + localVarQueryParameter['date.lt'] = dateLt; + } + + if (dateLte !== undefined) { + localVarQueryParameter['date.lte'] = dateLte; + } + + if (ticker !== undefined) { + localVarQueryParameter['ticker'] = ticker; + } + + if (tickerAnyOf !== undefined) { + localVarQueryParameter['ticker.any_of'] = tickerAnyOf; + } + + if (tickerGt !== undefined) { + localVarQueryParameter['ticker.gt'] = tickerGt; + } + + if (tickerGte !== undefined) { + localVarQueryParameter['ticker.gte'] = tickerGte; + } + + if (tickerLt !== undefined) { + localVarQueryParameter['ticker.lt'] = tickerLt; + } + + if (tickerLte !== undefined) { + localVarQueryParameter['ticker.lte'] = tickerLte; + } + + if (positioning !== undefined) { + localVarQueryParameter['positioning'] = positioning; + } + + if (positioningAnyOf !== undefined) { + localVarQueryParameter['positioning.any_of'] = positioningAnyOf; + } + + if (positioningGt !== undefined) { + localVarQueryParameter['positioning.gt'] = positioningGt; + } + + if (positioningGte !== undefined) { + localVarQueryParameter['positioning.gte'] = positioningGte; + } + + if (positioningLt !== undefined) { + localVarQueryParameter['positioning.lt'] = positioningLt; + } + + if (positioningLte !== undefined) { + localVarQueryParameter['positioning.lte'] = positioningLte; + } + + if (importance !== undefined) { + localVarQueryParameter['importance'] = importance; + } + + if (importanceAnyOf !== undefined) { + localVarQueryParameter['importance.any_of'] = importanceAnyOf; + } + + if (importanceGt !== undefined) { + localVarQueryParameter['importance.gt'] = importanceGt; + } + + if (importanceGte !== undefined) { + localVarQueryParameter['importance.gte'] = importanceGte; + } + + if (importanceLt !== undefined) { + localVarQueryParameter['importance.lt'] = importanceLt; + } + + if (importanceLte !== undefined) { + localVarQueryParameter['importance.lte'] = importanceLte; + } + + if (lastUpdated !== undefined) { + localVarQueryParameter['last_updated'] = lastUpdated; + } + + if (lastUpdatedAnyOf !== undefined) { + localVarQueryParameter['last_updated.any_of'] = lastUpdatedAnyOf; + } + + if (lastUpdatedGt !== undefined) { + localVarQueryParameter['last_updated.gt'] = lastUpdatedGt; + } + + if (lastUpdatedGte !== undefined) { + localVarQueryParameter['last_updated.gte'] = lastUpdatedGte; + } + + if (lastUpdatedLt !== undefined) { + localVarQueryParameter['last_updated.lt'] = lastUpdatedLt; + } + + if (lastUpdatedLte !== undefined) { + localVarQueryParameter['last_updated.lte'] = lastUpdatedLte; + } + + if (fiscalYear !== undefined) { + localVarQueryParameter['fiscal_year'] = fiscalYear; + } + + if (fiscalYearAnyOf !== undefined) { + localVarQueryParameter['fiscal_year.any_of'] = fiscalYearAnyOf; + } + + if (fiscalYearGt !== undefined) { + localVarQueryParameter['fiscal_year.gt'] = fiscalYearGt; + } + + if (fiscalYearGte !== undefined) { + localVarQueryParameter['fiscal_year.gte'] = fiscalYearGte; + } + + if (fiscalYearLt !== undefined) { + localVarQueryParameter['fiscal_year.lt'] = fiscalYearLt; + } + + if (fiscalYearLte !== undefined) { + localVarQueryParameter['fiscal_year.lte'] = fiscalYearLte; + } + + if (fiscalPeriod !== undefined) { + localVarQueryParameter['fiscal_period'] = fiscalPeriod; + } + + if (fiscalPeriodAnyOf !== undefined) { + localVarQueryParameter['fiscal_period.any_of'] = fiscalPeriodAnyOf; + } + + if (fiscalPeriodGt !== undefined) { + localVarQueryParameter['fiscal_period.gt'] = fiscalPeriodGt; + } + + if (fiscalPeriodGte !== undefined) { + localVarQueryParameter['fiscal_period.gte'] = fiscalPeriodGte; + } + + if (fiscalPeriodLt !== undefined) { + localVarQueryParameter['fiscal_period.lt'] = fiscalPeriodLt; + } + + if (fiscalPeriodLte !== undefined) { + localVarQueryParameter['fiscal_period.lte'] = fiscalPeriodLte; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * A comprehensive news article database from Benzinga, containing detailed information about financial news articles including metadata, content, and associated financial information. + * @param {string} [published] The timestamp (formatted as an ISO 8601 timestamp) when the news article was originally published. + * @param {string} [publishedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [publishedGt] Filter greater than the value. + * @param {string} [publishedGte] Filter greater than or equal to the value. + * @param {string} [publishedLt] Filter less than the value. + * @param {string} [publishedLte] Filter less than or equal to the value. + * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the news article was last updated in the system. + * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [lastUpdatedGt] Filter greater than the value. + * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. + * @param {string} [lastUpdatedLt] Filter less than the value. + * @param {string} [lastUpdatedLte] Filter less than or equal to the value. + * @param {string} [tickers] Filter for arrays that contain the value. + * @param {string} [tickersAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickersAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [channels] Filter for arrays that contain the value. + * @param {string} [channelsAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [channelsAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tags] Filter for arrays that contain the value. + * @param {string} [tagsAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tagsAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [author] The name of the journalist or entity that authored the news article. + * @param {string} [authorAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [authorGt] Filter greater than the value. + * @param {string} [authorGte] Filter greater than or equal to the value. + * @param {string} [authorLt] Filter less than the value. + * @param {string} [authorLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'published\' if not specified. The sort order defaults to \'desc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getBenzingaV1News: async (published?: string, publishedAnyOf?: string, publishedGt?: string, publishedGte?: string, publishedLt?: string, publishedLte?: string, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, tickers?: string, tickersAllOf?: string, tickersAnyOf?: string, channels?: string, channelsAllOf?: string, channelsAnyOf?: string, tags?: string, tagsAllOf?: string, tagsAnyOf?: string, author?: string, authorAnyOf?: string, authorGt?: string, authorGte?: string, authorLt?: string, authorLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/benzinga/v1/news`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + if (published !== undefined) { + localVarQueryParameter['published'] = published; + } + + if (publishedAnyOf !== undefined) { + localVarQueryParameter['published.any_of'] = publishedAnyOf; + } + + if (publishedGt !== undefined) { + localVarQueryParameter['published.gt'] = publishedGt; + } + + if (publishedGte !== undefined) { + localVarQueryParameter['published.gte'] = publishedGte; + } + + if (publishedLt !== undefined) { + localVarQueryParameter['published.lt'] = publishedLt; + } + + if (publishedLte !== undefined) { + localVarQueryParameter['published.lte'] = publishedLte; + } + + if (lastUpdated !== undefined) { + localVarQueryParameter['last_updated'] = lastUpdated; + } + + if (lastUpdatedAnyOf !== undefined) { + localVarQueryParameter['last_updated.any_of'] = lastUpdatedAnyOf; + } + + if (lastUpdatedGt !== undefined) { + localVarQueryParameter['last_updated.gt'] = lastUpdatedGt; + } + + if (lastUpdatedGte !== undefined) { + localVarQueryParameter['last_updated.gte'] = lastUpdatedGte; + } + + if (lastUpdatedLt !== undefined) { + localVarQueryParameter['last_updated.lt'] = lastUpdatedLt; + } + + if (lastUpdatedLte !== undefined) { + localVarQueryParameter['last_updated.lte'] = lastUpdatedLte; + } + + if (tickers !== undefined) { + localVarQueryParameter['tickers'] = tickers; + } + + if (tickersAllOf !== undefined) { + localVarQueryParameter['tickers.all_of'] = tickersAllOf; + } + + if (tickersAnyOf !== undefined) { + localVarQueryParameter['tickers.any_of'] = tickersAnyOf; + } + + if (channels !== undefined) { + localVarQueryParameter['channels'] = channels; + } + + if (channelsAllOf !== undefined) { + localVarQueryParameter['channels.all_of'] = channelsAllOf; + } + + if (channelsAnyOf !== undefined) { + localVarQueryParameter['channels.any_of'] = channelsAnyOf; + } + + if (tags !== undefined) { + localVarQueryParameter['tags'] = tags; + } + + if (tagsAllOf !== undefined) { + localVarQueryParameter['tags.all_of'] = tagsAllOf; + } + + if (tagsAnyOf !== undefined) { + localVarQueryParameter['tags.any_of'] = tagsAnyOf; + } + + if (author !== undefined) { + localVarQueryParameter['author'] = author; + } + + if (authorAnyOf !== undefined) { + localVarQueryParameter['author.any_of'] = authorAnyOf; + } + + if (authorGt !== undefined) { + localVarQueryParameter['author.gt'] = authorGt; + } + + if (authorGte !== undefined) { + localVarQueryParameter['author.gte'] = authorGte; + } + + if (authorLt !== undefined) { + localVarQueryParameter['author.lt'] = authorLt; + } + + if (authorLte !== undefined) { + localVarQueryParameter['author.lte'] = authorLte; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * This table contains analyst ratings and price target data from investment firms, tracking rating changes (upgrades, downgrades, initiates coverage, etc.) and price target adjustments for publicly traded companies. Each record includes the analyst details, company information, current and previous ratings/targets, and metadata like timestamps and Benzinga identifiers. + * @param {string} [date] The calendar date (formatted as YYYY-MM-DD) when the rating was issued. + * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [dateGt] Filter greater than the value. + * @param {string} [dateGte] Filter greater than or equal to the value. + * @param {string} [dateLt] Filter less than the value. + * @param {string} [dateLte] Filter less than or equal to the value. + * @param {string} [ticker] The stock symbol of the company being rated. + * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickerGt] Filter greater than the value. + * @param {string} [tickerGte] Filter greater than or equal to the value. + * @param {string} [tickerLt] Filter less than the value. + * @param {string} [tickerLte] Filter less than or equal to the value. + * @param {number} [importance] A subjective indicator of the importance of the earnings event, on a scale from 0 (lowest) to 5 (highest). Value must be an integer. + * @param {number} [importanceGt] Filter greater than the value. Value must be an integer. + * @param {number} [importanceGte] Filter greater than or equal to the value. Value must be an integer. + * @param {number} [importanceLt] Filter less than the value. Value must be an integer. + * @param {number} [importanceLte] Filter less than or equal to the value. Value must be an integer. + * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedGt] Filter greater than the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedLt] Filter less than the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedLte] Filter less than or equal to the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [ratingAction] The description of the change in rating from the firm\'s last rating. Possible values include: downgrades, maintains, reinstates, reiterates, upgrades, assumes, initiates_coverage_on, terminates_coverage_on, removes, suspends, firm_dissolved. + * @param {string} [ratingActionAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [ratingActionGt] Filter greater than the value. + * @param {string} [ratingActionGte] Filter greater than or equal to the value. + * @param {string} [ratingActionLt] Filter less than the value. + * @param {string} [ratingActionLte] Filter less than or equal to the value. + * @param {string} [priceTargetAction] The description of the directional change in price target. Possible values include: raises, lowers, maintains, announces, sets. + * @param {string} [priceTargetActionAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [priceTargetActionGt] Filter greater than the value. + * @param {string} [priceTargetActionGte] Filter greater than or equal to the value. + * @param {string} [priceTargetActionLt] Filter less than the value. + * @param {string} [priceTargetActionLte] Filter less than or equal to the value. + * @param {string} [benzingaId] The identifer used by Benzinga for this record. + * @param {string} [benzingaIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [benzingaIdGt] Filter greater than the value. + * @param {string} [benzingaIdGte] Filter greater than or equal to the value. + * @param {string} [benzingaIdLt] Filter less than the value. + * @param {string} [benzingaIdLte] Filter less than or equal to the value. + * @param {string} [benzingaAnalystId] The identifer used by Benzinga for this analyst. + * @param {string} [benzingaAnalystIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [benzingaAnalystIdGt] Filter greater than the value. + * @param {string} [benzingaAnalystIdGte] Filter greater than or equal to the value. + * @param {string} [benzingaAnalystIdLt] Filter less than the value. + * @param {string} [benzingaAnalystIdLte] Filter less than or equal to the value. + * @param {string} [benzingaFirmId] The identifer used by Benzinga for this firm. + * @param {string} [benzingaFirmIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [benzingaFirmIdGt] Filter greater than the value. + * @param {string} [benzingaFirmIdGte] Filter greater than or equal to the value. + * @param {string} [benzingaFirmIdLt] Filter less than the value. + * @param {string} [benzingaFirmIdLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'last_updated\' if not specified. The sort order defaults to \'desc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getBenzingaV1Ratings: async (date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, importance?: number, importanceGt?: number, importanceGte?: number, importanceLt?: number, importanceLte?: number, lastUpdated?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, ratingAction?: string, ratingActionAnyOf?: string, ratingActionGt?: string, ratingActionGte?: string, ratingActionLt?: string, ratingActionLte?: string, priceTargetAction?: string, priceTargetActionAnyOf?: string, priceTargetActionGt?: string, priceTargetActionGte?: string, priceTargetActionLt?: string, priceTargetActionLte?: string, benzingaId?: string, benzingaIdAnyOf?: string, benzingaIdGt?: string, benzingaIdGte?: string, benzingaIdLt?: string, benzingaIdLte?: string, benzingaAnalystId?: string, benzingaAnalystIdAnyOf?: string, benzingaAnalystIdGt?: string, benzingaAnalystIdGte?: string, benzingaAnalystIdLt?: string, benzingaAnalystIdLte?: string, benzingaFirmId?: string, benzingaFirmIdAnyOf?: string, benzingaFirmIdGt?: string, benzingaFirmIdGte?: string, benzingaFirmIdLt?: string, benzingaFirmIdLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/benzinga/v1/ratings`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + if (date !== undefined) { + localVarQueryParameter['date'] = date; + } + + if (dateAnyOf !== undefined) { + localVarQueryParameter['date.any_of'] = dateAnyOf; + } + + if (dateGt !== undefined) { + localVarQueryParameter['date.gt'] = dateGt; + } + + if (dateGte !== undefined) { + localVarQueryParameter['date.gte'] = dateGte; + } + + if (dateLt !== undefined) { + localVarQueryParameter['date.lt'] = dateLt; + } + + if (dateLte !== undefined) { + localVarQueryParameter['date.lte'] = dateLte; + } + + if (ticker !== undefined) { + localVarQueryParameter['ticker'] = ticker; + } + + if (tickerAnyOf !== undefined) { + localVarQueryParameter['ticker.any_of'] = tickerAnyOf; + } + + if (tickerGt !== undefined) { + localVarQueryParameter['ticker.gt'] = tickerGt; + } + + if (tickerGte !== undefined) { + localVarQueryParameter['ticker.gte'] = tickerGte; + } + + if (tickerLt !== undefined) { + localVarQueryParameter['ticker.lt'] = tickerLt; + } + + if (tickerLte !== undefined) { + localVarQueryParameter['ticker.lte'] = tickerLte; + } + + if (importance !== undefined) { + localVarQueryParameter['importance'] = importance; + } + + if (importanceGt !== undefined) { + localVarQueryParameter['importance.gt'] = importanceGt; + } + + if (importanceGte !== undefined) { + localVarQueryParameter['importance.gte'] = importanceGte; + } + + if (importanceLt !== undefined) { + localVarQueryParameter['importance.lt'] = importanceLt; + } + + if (importanceLte !== undefined) { + localVarQueryParameter['importance.lte'] = importanceLte; + } + + if (lastUpdated !== undefined) { + localVarQueryParameter['last_updated'] = lastUpdated; + } + + if (lastUpdatedGt !== undefined) { + localVarQueryParameter['last_updated.gt'] = lastUpdatedGt; + } + + if (lastUpdatedGte !== undefined) { + localVarQueryParameter['last_updated.gte'] = lastUpdatedGte; + } + + if (lastUpdatedLt !== undefined) { + localVarQueryParameter['last_updated.lt'] = lastUpdatedLt; + } + + if (lastUpdatedLte !== undefined) { + localVarQueryParameter['last_updated.lte'] = lastUpdatedLte; + } + + if (ratingAction !== undefined) { + localVarQueryParameter['rating_action'] = ratingAction; + } + + if (ratingActionAnyOf !== undefined) { + localVarQueryParameter['rating_action.any_of'] = ratingActionAnyOf; + } + + if (ratingActionGt !== undefined) { + localVarQueryParameter['rating_action.gt'] = ratingActionGt; + } + + if (ratingActionGte !== undefined) { + localVarQueryParameter['rating_action.gte'] = ratingActionGte; + } + + if (ratingActionLt !== undefined) { + localVarQueryParameter['rating_action.lt'] = ratingActionLt; + } + + if (ratingActionLte !== undefined) { + localVarQueryParameter['rating_action.lte'] = ratingActionLte; + } + + if (priceTargetAction !== undefined) { + localVarQueryParameter['price_target_action'] = priceTargetAction; + } + + if (priceTargetActionAnyOf !== undefined) { + localVarQueryParameter['price_target_action.any_of'] = priceTargetActionAnyOf; + } + + if (priceTargetActionGt !== undefined) { + localVarQueryParameter['price_target_action.gt'] = priceTargetActionGt; + } + + if (priceTargetActionGte !== undefined) { + localVarQueryParameter['price_target_action.gte'] = priceTargetActionGte; + } + + if (priceTargetActionLt !== undefined) { + localVarQueryParameter['price_target_action.lt'] = priceTargetActionLt; + } + + if (priceTargetActionLte !== undefined) { + localVarQueryParameter['price_target_action.lte'] = priceTargetActionLte; + } + + if (benzingaId !== undefined) { + localVarQueryParameter['benzinga_id'] = benzingaId; + } + + if (benzingaIdAnyOf !== undefined) { + localVarQueryParameter['benzinga_id.any_of'] = benzingaIdAnyOf; + } + + if (benzingaIdGt !== undefined) { + localVarQueryParameter['benzinga_id.gt'] = benzingaIdGt; + } + + if (benzingaIdGte !== undefined) { + localVarQueryParameter['benzinga_id.gte'] = benzingaIdGte; + } + + if (benzingaIdLt !== undefined) { + localVarQueryParameter['benzinga_id.lt'] = benzingaIdLt; + } + + if (benzingaIdLte !== undefined) { + localVarQueryParameter['benzinga_id.lte'] = benzingaIdLte; + } + + if (benzingaAnalystId !== undefined) { + localVarQueryParameter['benzinga_analyst_id'] = benzingaAnalystId; + } + + if (benzingaAnalystIdAnyOf !== undefined) { + localVarQueryParameter['benzinga_analyst_id.any_of'] = benzingaAnalystIdAnyOf; + } + + if (benzingaAnalystIdGt !== undefined) { + localVarQueryParameter['benzinga_analyst_id.gt'] = benzingaAnalystIdGt; + } + + if (benzingaAnalystIdGte !== undefined) { + localVarQueryParameter['benzinga_analyst_id.gte'] = benzingaAnalystIdGte; + } + + if (benzingaAnalystIdLt !== undefined) { + localVarQueryParameter['benzinga_analyst_id.lt'] = benzingaAnalystIdLt; + } + + if (benzingaAnalystIdLte !== undefined) { + localVarQueryParameter['benzinga_analyst_id.lte'] = benzingaAnalystIdLte; + } + + if (benzingaFirmId !== undefined) { + localVarQueryParameter['benzinga_firm_id'] = benzingaFirmId; + } + + if (benzingaFirmIdAnyOf !== undefined) { + localVarQueryParameter['benzinga_firm_id.any_of'] = benzingaFirmIdAnyOf; + } + + if (benzingaFirmIdGt !== undefined) { + localVarQueryParameter['benzinga_firm_id.gt'] = benzingaFirmIdGt; + } + + if (benzingaFirmIdGte !== undefined) { + localVarQueryParameter['benzinga_firm_id.gte'] = benzingaFirmIdGte; + } + + if (benzingaFirmIdLt !== undefined) { + localVarQueryParameter['benzinga_firm_id.lt'] = benzingaFirmIdLt; + } + + if (benzingaFirmIdLte !== undefined) { + localVarQueryParameter['benzinga_firm_id.lte'] = benzingaFirmIdLte; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * A comprehensive news article database from Benzinga, containing detailed information about financial news articles including metadata, content, and associated financial information. + * @param {string} [published] The timestamp (formatted as an ISO 8601 timestamp) when the news article was originally published. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [publishedGt] Filter greater than the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [publishedGte] Filter greater than or equal to the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [publishedLt] Filter less than the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [publishedLte] Filter less than or equal to the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [channels] Filter for arrays that contain the value. + * @param {string} [channelsAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [channelsAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tags] Filter for arrays that contain the value. + * @param {string} [tagsAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tagsAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [author] The name of the journalist or entity that authored the news article. + * @param {string} [authorAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [authorGt] Filter greater than the value. + * @param {string} [authorGte] Filter greater than or equal to the value. + * @param {string} [authorLt] Filter less than the value. + * @param {string} [authorLte] Filter less than or equal to the value. + * @param {string} [stocks] Filter for arrays that contain the value. + * @param {string} [stocksAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [stocksAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickers] Filter for arrays that contain the value. + * @param {string} [tickersAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickersAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'published\' if not specified. The sort order defaults to \'desc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getBenzingaV2News: async (published?: string, publishedGt?: string, publishedGte?: string, publishedLt?: string, publishedLte?: string, channels?: string, channelsAllOf?: string, channelsAnyOf?: string, tags?: string, tagsAllOf?: string, tagsAnyOf?: string, author?: string, authorAnyOf?: string, authorGt?: string, authorGte?: string, authorLt?: string, authorLte?: string, stocks?: string, stocksAllOf?: string, stocksAnyOf?: string, tickers?: string, tickersAllOf?: string, tickersAnyOf?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/benzinga/v2/news`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + if (published !== undefined) { + localVarQueryParameter['published'] = published; + } + + if (publishedGt !== undefined) { + localVarQueryParameter['published.gt'] = publishedGt; + } + + if (publishedGte !== undefined) { + localVarQueryParameter['published.gte'] = publishedGte; + } + + if (publishedLt !== undefined) { + localVarQueryParameter['published.lt'] = publishedLt; + } + + if (publishedLte !== undefined) { + localVarQueryParameter['published.lte'] = publishedLte; + } + + if (channels !== undefined) { + localVarQueryParameter['channels'] = channels; + } + + if (channelsAllOf !== undefined) { + localVarQueryParameter['channels.all_of'] = channelsAllOf; + } + + if (channelsAnyOf !== undefined) { + localVarQueryParameter['channels.any_of'] = channelsAnyOf; + } + + if (tags !== undefined) { + localVarQueryParameter['tags'] = tags; + } + + if (tagsAllOf !== undefined) { + localVarQueryParameter['tags.all_of'] = tagsAllOf; + } + + if (tagsAnyOf !== undefined) { + localVarQueryParameter['tags.any_of'] = tagsAnyOf; + } + + if (author !== undefined) { + localVarQueryParameter['author'] = author; + } + + if (authorAnyOf !== undefined) { + localVarQueryParameter['author.any_of'] = authorAnyOf; + } + + if (authorGt !== undefined) { + localVarQueryParameter['author.gt'] = authorGt; + } + + if (authorGte !== undefined) { + localVarQueryParameter['author.gte'] = authorGte; + } + + if (authorLt !== undefined) { + localVarQueryParameter['author.lt'] = authorLt; + } + + if (authorLte !== undefined) { + localVarQueryParameter['author.lte'] = authorLte; + } + + if (stocks !== undefined) { + localVarQueryParameter['stocks'] = stocks; + } + + if (stocksAllOf !== undefined) { + localVarQueryParameter['stocks.all_of'] = stocksAllOf; + } + + if (stocksAnyOf !== undefined) { + localVarQueryParameter['stocks.any_of'] = stocksAnyOf; + } + + if (tickers !== undefined) { + localVarQueryParameter['tickers'] = tickers; + } + + if (tickersAllOf !== undefined) { + localVarQueryParameter['tickers.all_of'] = tickersAllOf; + } + + if (tickersAnyOf !== undefined) { + localVarQueryParameter['tickers.any_of'] = tickersAnyOf; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get aggregate bars for a cryptocurrency pair over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. + * @summary Aggregates (Bars) + * @param {string} cryptoTicker The ticker symbol of the currency pair. + * @param {number} multiplier The size of the timespan multiplier. + * @param {GetCryptoAggregatesTimespanEnum} timespan The size of the time window. + * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. + * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. + * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. + * @param {GetCryptoAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). + * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://massive.com/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getCryptoAggregates: async (cryptoTicker: string, multiplier: number, timespan: GetCryptoAggregatesTimespanEnum, from: string, to: string, adjusted?: boolean, sort?: GetCryptoAggregatesSortEnum, limit?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'cryptoTicker' is not null or undefined + assertParamExists('getCryptoAggregates', 'cryptoTicker', cryptoTicker) + // verify required parameter 'multiplier' is not null or undefined + assertParamExists('getCryptoAggregates', 'multiplier', multiplier) + // verify required parameter 'timespan' is not null or undefined + assertParamExists('getCryptoAggregates', 'timespan', timespan) + // verify required parameter 'from' is not null or undefined + assertParamExists('getCryptoAggregates', 'from', from) + // verify required parameter 'to' is not null or undefined + assertParamExists('getCryptoAggregates', 'to', to) + const localVarPath = `/v2/aggs/ticker/{cryptoTicker}/range/{multiplier}/{timespan}/{from}/{to}` + .replace(`{${"cryptoTicker"}}`, encodeURIComponent(String(cryptoTicker))) + .replace(`{${"multiplier"}}`, encodeURIComponent(String(multiplier))) + .replace(`{${"timespan"}}`, encodeURIComponent(String(timespan))) + .replace(`{${"from"}}`, encodeURIComponent(String(from))) + .replace(`{${"to"}}`, encodeURIComponent(String(to))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + if (adjusted !== undefined) { + localVarQueryParameter['adjusted'] = adjusted; + } + + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get the exponential moving average (EMA) for a ticker symbol over a given time range. + * @summary Exponential Moving Average (EMA) + * @param {string} cryptoTicker The ticker symbol for which to get exponential moving average (EMA) data. + * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. + * @param {GetCryptoEMATimespanEnum} [timespan] The size of the aggregate time window. + * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. + * @param {GetCryptoEMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close prices to calculate the exponential moving average (EMA). + * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. + * @param {GetCryptoEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. + * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 + * @param {string} [timestampGte] Range by timestamp. + * @param {string} [timestampGt] Range by timestamp. + * @param {string} [timestampLte] Range by timestamp. + * @param {string} [timestampLt] Range by timestamp. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getCryptoEMA: async (cryptoTicker: string, timestamp?: string, timespan?: GetCryptoEMATimespanEnum, window?: number, seriesType?: GetCryptoEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetCryptoEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'cryptoTicker' is not null or undefined + assertParamExists('getCryptoEMA', 'cryptoTicker', cryptoTicker) + const localVarPath = `/v1/indicators/ema/{cryptoTicker}` + .replace(`{${"cryptoTicker"}}`, encodeURIComponent(String(cryptoTicker))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + if (timestamp !== undefined) { + localVarQueryParameter['timestamp'] = timestamp; + } + + if (timespan !== undefined) { + localVarQueryParameter['timespan'] = timespan; + } + + if (window !== undefined) { + localVarQueryParameter['window'] = window; + } + + if (seriesType !== undefined) { + localVarQueryParameter['series_type'] = seriesType; + } + + if (expandUnderlying !== undefined) { + localVarQueryParameter['expand_underlying'] = expandUnderlying; + } + + if (order !== undefined) { + localVarQueryParameter['order'] = order; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (timestampGte !== undefined) { + localVarQueryParameter['timestamp.gte'] = timestampGte; + } + + if (timestampGt !== undefined) { + localVarQueryParameter['timestamp.gt'] = timestampGt; + } + + if (timestampLte !== undefined) { + localVarQueryParameter['timestamp.lte'] = timestampLte; + } + + if (timestampLt !== undefined) { + localVarQueryParameter['timestamp.lt'] = timestampLt; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, /** - * Get the current level 2 book of a single ticker. This is the combined book from all of the exchanges.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. - * @summary Ticker Full Book (L2) - * @param {string} ticker The cryptocurrency ticker. + * Get moving average convergence/divergence (MACD) data for a ticker symbol over a given time range. + * @summary Moving Average Convergence/Divergence (MACD) + * @param {string} cryptoTicker The ticker symbol for which to get MACD data. + * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. + * @param {GetCryptoMACDTimespanEnum} [timespan] The size of the aggregate time window. + * @param {number} [shortWindow] The short window size used to calculate MACD data. + * @param {number} [longWindow] The long window size used to calculate MACD data. + * @param {number} [signalWindow] The window size used to calculate the MACD signal line. + * @param {GetCryptoMACDSeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate MACD data. i.e. \'close\' will result in using close prices to calculate the MACD. + * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. + * @param {GetCryptoMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. + * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 + * @param {string} [timestampGte] Range by timestamp. + * @param {string} [timestampGt] Range by timestamp. + * @param {string} [timestampLte] Range by timestamp. + * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deprecatedGetCryptoSnapshotTickerBook: async (ticker: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'ticker' is not null or undefined - assertParamExists('deprecatedGetCryptoSnapshotTickerBook', 'ticker', ticker) - const localVarPath = `/v2/snapshot/locale/global/markets/crypto/tickers/{ticker}/book` - .replace(`{${"ticker"}}`, encodeURIComponent(String(ticker))); + getCryptoMACD: async (cryptoTicker: string, timestamp?: string, timespan?: GetCryptoMACDTimespanEnum, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetCryptoMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetCryptoMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'cryptoTicker' is not null or undefined + assertParamExists('getCryptoMACD', 'cryptoTicker', cryptoTicker) + const localVarPath = `/v1/indicators/macd/{cryptoTicker}` + .replace(`{${"cryptoTicker"}}`, encodeURIComponent(String(cryptoTicker))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -12950,6 +18491,58 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (timestamp !== undefined) { + localVarQueryParameter['timestamp'] = timestamp; + } + + if (timespan !== undefined) { + localVarQueryParameter['timespan'] = timespan; + } + + if (shortWindow !== undefined) { + localVarQueryParameter['short_window'] = shortWindow; + } + + if (longWindow !== undefined) { + localVarQueryParameter['long_window'] = longWindow; + } + + if (signalWindow !== undefined) { + localVarQueryParameter['signal_window'] = signalWindow; + } + + if (seriesType !== undefined) { + localVarQueryParameter['series_type'] = seriesType; + } + + if (expandUnderlying !== undefined) { + localVarQueryParameter['expand_underlying'] = expandUnderlying; + } + + if (order !== undefined) { + localVarQueryParameter['order'] = order; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (timestampGte !== undefined) { + localVarQueryParameter['timestamp.gte'] = timestampGte; + } + + if (timestampGt !== undefined) { + localVarQueryParameter['timestamp.gt'] = timestampGt; + } + + if (timestampLte !== undefined) { + localVarQueryParameter['timestamp.lte'] = timestampLte; + } + + if (timestampLt !== undefined) { + localVarQueryParameter['timestamp.lt'] = timestampLt; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -12962,24 +18555,23 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get historic trade ticks for a cryptocurrency pair. - * @summary Historic Crypto Trades - * @param {string} from The \"from\" symbol of the crypto pair. - * @param {string} to The \"to\" symbol of the crypto pair. - * @param {string} date The date/day of the historic ticks to retrieve. - * @param {number} [offset] The timestamp offset, used for pagination. This is the offset at which to start the results. Using the `timestamp` of the last result as the offset will give you the next page of results. - * @param {number} [limit] Limit the size of the response, max 10000. + * Get the open, close prices of a cryptocurrency symbol on a certain day. + * @summary Daily Open/Close + * @param {string} from The \"from\" symbol of the pair. + * @param {string} to The \"to\" symbol of the pair. + * @param {string} date The date of the requested open/close in the format YYYY-MM-DD. + * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deprecatedGetHistoricCryptoTrades: async (from: string, to: string, date: string, offset?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise => { + getCryptoOpenClose: async (from: string, to: string, date: string, adjusted?: boolean, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'from' is not null or undefined - assertParamExists('deprecatedGetHistoricCryptoTrades', 'from', from) + assertParamExists('getCryptoOpenClose', 'from', from) // verify required parameter 'to' is not null or undefined - assertParamExists('deprecatedGetHistoricCryptoTrades', 'to', to) + assertParamExists('getCryptoOpenClose', 'to', to) // verify required parameter 'date' is not null or undefined - assertParamExists('deprecatedGetHistoricCryptoTrades', 'date', date) - const localVarPath = `/v1/historic/crypto/{from}/{to}/{date}` + assertParamExists('getCryptoOpenClose', 'date', date) + const localVarPath = `/v1/open-close/crypto/{from}/{to}/{date}` .replace(`{${"from"}}`, encodeURIComponent(String(from))) .replace(`{${"to"}}`, encodeURIComponent(String(to))) .replace(`{${"date"}}`, encodeURIComponent(String(date))); @@ -12997,12 +18589,100 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; + if (adjusted !== undefined) { + localVarQueryParameter['adjusted'] = adjusted; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get the relative strength index (RSI) for a ticker symbol over a given time range. + * @summary Relative Strength Index (RSI) + * @param {string} cryptoTicker The ticker symbol for which to get relative strength index (RSI) data. + * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. + * @param {GetCryptoRSITimespanEnum} [timespan] The size of the aggregate time window. + * @param {number} [window] The window size used to calculate the relative strength index (RSI). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. + * @param {GetCryptoRSISeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close prices to calculate the relative strength index (RSI). + * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. + * @param {GetCryptoRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. + * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 + * @param {string} [timestampGte] Range by timestamp. + * @param {string} [timestampGt] Range by timestamp. + * @param {string} [timestampLte] Range by timestamp. + * @param {string} [timestampLt] Range by timestamp. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getCryptoRSI: async (cryptoTicker: string, timestamp?: string, timespan?: GetCryptoRSITimespanEnum, window?: number, seriesType?: GetCryptoRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetCryptoRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'cryptoTicker' is not null or undefined + assertParamExists('getCryptoRSI', 'cryptoTicker', cryptoTicker) + const localVarPath = `/v1/indicators/rsi/{cryptoTicker}` + .replace(`{${"cryptoTicker"}}`, encodeURIComponent(String(cryptoTicker))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + if (timestamp !== undefined) { + localVarQueryParameter['timestamp'] = timestamp; + } + + if (timespan !== undefined) { + localVarQueryParameter['timespan'] = timespan; + } + + if (window !== undefined) { + localVarQueryParameter['window'] = window; + } + + if (seriesType !== undefined) { + localVarQueryParameter['series_type'] = seriesType; + } + + if (expandUnderlying !== undefined) { + localVarQueryParameter['expand_underlying'] = expandUnderlying; + } + + if (order !== undefined) { + localVarQueryParameter['order'] = order; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (timestampGte !== undefined) { + localVarQueryParameter['timestamp.gte'] = timestampGte; + } + + if (timestampGt !== undefined) { + localVarQueryParameter['timestamp.gt'] = timestampGt; + } + + if (timestampLte !== undefined) { + localVarQueryParameter['timestamp.lte'] = timestampLte; } - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; + if (timestampLt !== undefined) { + localVarQueryParameter['timestamp.lt'] = timestampLt; } @@ -13017,27 +18697,28 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get historic ticks for a forex currency pair. - * @summary Historic Forex Ticks - * @param {string} from The \"from\" symbol of the currency pair. Example: For **USD/JPY** the `from` would be **USD**. - * @param {string} to The \"to\" symbol of the currency pair. Example: For **USD/JPY** the `to` would be **JPY**. - * @param {string} date The date/day of the historic ticks to retrieve. - * @param {number} [offset] The timestamp offset, used for pagination. This is the offset at which to start the results. Using the `timestamp` of the last result as the offset will give you the next page of results. - * @param {number} [limit] Limit the size of the response, max 10000. + * Get the simple moving average (SMA) for a ticker symbol over a given time range. + * @summary Simple Moving Average (SMA) + * @param {string} cryptoTicker The ticker symbol for which to get simple moving average (SMA) data. + * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. + * @param {GetCryptoSMATimespanEnum} [timespan] The size of the aggregate time window. + * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. + * @param {GetCryptoSMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close prices to calculate the simple moving average (SMA). + * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. + * @param {GetCryptoSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. + * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 + * @param {string} [timestampGte] Range by timestamp. + * @param {string} [timestampGt] Range by timestamp. + * @param {string} [timestampLte] Range by timestamp. + * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deprecatedGetHistoricForexQuotes: async (from: string, to: string, date: string, offset?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'from' is not null or undefined - assertParamExists('deprecatedGetHistoricForexQuotes', 'from', from) - // verify required parameter 'to' is not null or undefined - assertParamExists('deprecatedGetHistoricForexQuotes', 'to', to) - // verify required parameter 'date' is not null or undefined - assertParamExists('deprecatedGetHistoricForexQuotes', 'date', date) - const localVarPath = `/v1/historic/forex/{from}/{to}/{date}` - .replace(`{${"from"}}`, encodeURIComponent(String(from))) - .replace(`{${"to"}}`, encodeURIComponent(String(to))) - .replace(`{${"date"}}`, encodeURIComponent(String(date))); + getCryptoSMA: async (cryptoTicker: string, timestamp?: string, timespan?: GetCryptoSMATimespanEnum, window?: number, seriesType?: GetCryptoSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetCryptoSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'cryptoTicker' is not null or undefined + assertParamExists('getCryptoSMA', 'cryptoTicker', cryptoTicker) + const localVarPath = `/v1/indicators/sma/{cryptoTicker}` + .replace(`{${"cryptoTicker"}}`, encodeURIComponent(String(cryptoTicker))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -13052,14 +18733,50 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; + if (timestamp !== undefined) { + localVarQueryParameter['timestamp'] = timestamp; + } + + if (timespan !== undefined) { + localVarQueryParameter['timespan'] = timespan; + } + + if (window !== undefined) { + localVarQueryParameter['window'] = window; + } + + if (seriesType !== undefined) { + localVarQueryParameter['series_type'] = seriesType; + } + + if (expandUnderlying !== undefined) { + localVarQueryParameter['expand_underlying'] = expandUnderlying; + } + + if (order !== undefined) { + localVarQueryParameter['order'] = order; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } + if (timestampGte !== undefined) { + localVarQueryParameter['timestamp.gte'] = timestampGte; + } + + if (timestampGt !== undefined) { + localVarQueryParameter['timestamp.gt'] = timestampGt; + } + + if (timestampLte !== undefined) { + localVarQueryParameter['timestamp.lte'] = timestampLte; + } + + if (timestampLt !== undefined) { + localVarQueryParameter['timestamp.lt'] = timestampLt; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -13072,25 +18789,17 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get NBBO quotes for a given ticker symbol on a specified date. - * @summary Quotes (NBBO) - * @param {string} ticker The ticker symbol we want quotes for. - * @param {string} date The date/day of the quotes to retrieve in the format YYYY-MM-DD. - * @param {number} [timestamp] The timestamp offset, used for pagination. This is the offset at which to start the results. Using the `timestamp` of the last result as the offset will give you the next page of results. - * @param {number} [timestampLimit] The maximum timestamp allowed in the results. - * @param {boolean} [reverse] Reverse the order of the results. - * @param {number} [limit] Limit the size of the response, max 50000 and default 5000. + * Get the current top 20 gainers or losers of the day in cryptocurrency markets.

Top gainers are those tickers whose price has increased by the highest percentage since the previous day\'s close. Top losers are those tickers whose price has decreased by the highest percentage since the previous day\'s close.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. + * @summary Gainers/Losers + * @param {GetCryptoSnapshotDirectionDirectionEnum} direction The direction of the snapshot results to return. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deprecatedGetHistoricStocksQuotes: async (ticker: string, date: string, timestamp?: number, timestampLimit?: number, reverse?: boolean, limit?: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'ticker' is not null or undefined - assertParamExists('deprecatedGetHistoricStocksQuotes', 'ticker', ticker) - // verify required parameter 'date' is not null or undefined - assertParamExists('deprecatedGetHistoricStocksQuotes', 'date', date) - const localVarPath = `/v2/ticks/stocks/nbbo/{ticker}/{date}` - .replace(`{${"ticker"}}`, encodeURIComponent(String(ticker))) - .replace(`{${"date"}}`, encodeURIComponent(String(date))); + getCryptoSnapshotDirection: async (direction: GetCryptoSnapshotDirectionDirectionEnum, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'direction' is not null or undefined + assertParamExists('getCryptoSnapshotDirection', 'direction', direction) + const localVarPath = `/v2/snapshot/locale/global/markets/crypto/{direction}` + .replace(`{${"direction"}}`, encodeURIComponent(String(direction))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -13105,22 +18814,6 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (timestamp !== undefined) { - localVarQueryParameter['timestamp'] = timestamp; - } - - if (timestampLimit !== undefined) { - localVarQueryParameter['timestampLimit'] = timestampLimit; - } - - if (reverse !== undefined) { - localVarQueryParameter['reverse'] = reverse; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -13133,25 +18826,17 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get trades for a given ticker symbol on a specified date. - * @summary Trades - * @param {string} ticker The ticker symbol we want trades for. - * @param {string} date The date/day of the trades to retrieve in the format YYYY-MM-DD. - * @param {number} [timestamp] The timestamp offset, used for pagination. This is the offset at which to start the results. Using the `timestamp` of the last result as the offset will give you the next page of results. - * @param {number} [timestampLimit] The maximum timestamp allowed in the results. - * @param {boolean} [reverse] Reverse the order of the results. - * @param {number} [limit] Limit the size of the response, max 50000 and default 5000. + * Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for a single traded cryptocurrency symbol.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. + * @summary Ticker + * @param {string} ticker Ticker of the snapshot * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deprecatedGetHistoricStocksTrades: async (ticker: string, date: string, timestamp?: number, timestampLimit?: number, reverse?: boolean, limit?: number, options: RawAxiosRequestConfig = {}): Promise => { + getCryptoSnapshotTicker: async (ticker: string, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'ticker' is not null or undefined - assertParamExists('deprecatedGetHistoricStocksTrades', 'ticker', ticker) - // verify required parameter 'date' is not null or undefined - assertParamExists('deprecatedGetHistoricStocksTrades', 'date', date) - const localVarPath = `/v2/ticks/stocks/trades/{ticker}/{date}` - .replace(`{${"ticker"}}`, encodeURIComponent(String(ticker))) - .replace(`{${"date"}}`, encodeURIComponent(String(date))); + assertParamExists('getCryptoSnapshotTicker', 'ticker', ticker) + const localVarPath = `/v2/snapshot/locale/global/markets/crypto/tickers/{ticker}` + .replace(`{${"ticker"}}`, encodeURIComponent(String(ticker))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -13166,22 +18851,6 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (timestamp !== undefined) { - localVarQueryParameter['timestamp'] = timestamp; - } - - if (timestampLimit !== undefined) { - localVarQueryParameter['timestampLimit'] = timestampLimit; - } - - if (reverse !== undefined) { - localVarQueryParameter['reverse'] = reverse; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -13194,56 +18863,14 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * A comprehensive database of financial analyst insights and ratings for various publicly traded companies, capturing detailed information about analyst recommendations and price targets. - * @param {string} [date] The calendar date (formatted as YYYY-MM-DD) when the rating was issued. - * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [dateGt] Filter greater than the value. - * @param {string} [dateGte] Filter greater than or equal to the value. - * @param {string} [dateLt] Filter less than the value. - * @param {string} [dateLte] Filter less than or equal to the value. - * @param {string} [ticker] The stock symbol of the company being rated. - * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [tickerGt] Filter greater than the value. - * @param {string} [tickerGte] Filter greater than or equal to the value. - * @param {string} [tickerLt] Filter less than the value. - * @param {string} [tickerLte] Filter less than or equal to the value. - * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system. - * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [lastUpdatedGt] Filter greater than the value. - * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. - * @param {string} [lastUpdatedLt] Filter less than the value. - * @param {string} [lastUpdatedLte] Filter less than or equal to the value. - * @param {string} [firm] The name of the research firm or investment bank issuing the rating. - * @param {string} [firmAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [firmGt] Filter greater than the value. - * @param {string} [firmGte] Filter greater than or equal to the value. - * @param {string} [firmLt] Filter less than the value. - * @param {string} [firmLte] Filter less than or equal to the value. - * @param {string} [ratingAction] The description of the change in rating from the firm\'s last rating. Possible values include: downgrades, maintains, reinstates, reiterates, upgrades, assumes, initiates_coverage_on, terminates_coverage_on, removes, suspends, firm_dissolved. - * @param {string} [ratingActionAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [ratingActionGt] Filter greater than the value. - * @param {string} [ratingActionGte] Filter greater than or equal to the value. - * @param {string} [ratingActionLt] Filter less than the value. - * @param {string} [ratingActionLte] Filter less than or equal to the value. - * @param {string} [benzingaFirmId] The identifer used by Benzinga for the firm record. - * @param {string} [benzingaFirmIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [benzingaFirmIdGt] Filter greater than the value. - * @param {string} [benzingaFirmIdGte] Filter greater than or equal to the value. - * @param {string} [benzingaFirmIdLt] Filter less than the value. - * @param {string} [benzingaFirmIdLte] Filter less than or equal to the value. - * @param {string} [benzingaRatingId] The identifier used by Benzinga for the rating record. - * @param {string} [benzingaRatingIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [benzingaRatingIdGt] Filter greater than the value. - * @param {string} [benzingaRatingIdGte] Filter greater than or equal to the value. - * @param {string} [benzingaRatingIdLt] Filter less than the value. - * @param {string} [benzingaRatingIdLte] Filter less than or equal to the value. - * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. - * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. + * Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for all traded cryptocurrency symbols.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST. + * @summary All Tickers + * @param {Array} [tickers] A case-sensitive comma separated list of tickers to get snapshots for. For example, X:BTCUSD, X:ETHBTC, and X:BOBAUSD. Empty string defaults to querying all tickers. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getBenzingaV1AnalystInsights: async (date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, firm?: string, firmAnyOf?: string, firmGt?: string, firmGte?: string, firmLt?: string, firmLte?: string, ratingAction?: string, ratingActionAnyOf?: string, ratingActionGt?: string, ratingActionGte?: string, ratingActionLt?: string, ratingActionLte?: string, benzingaFirmId?: string, benzingaFirmIdAnyOf?: string, benzingaFirmIdGt?: string, benzingaFirmIdGte?: string, benzingaFirmIdLt?: string, benzingaFirmIdLte?: string, benzingaRatingId?: string, benzingaRatingIdAnyOf?: string, benzingaRatingIdGt?: string, benzingaRatingIdGte?: string, benzingaRatingIdLt?: string, benzingaRatingIdLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/benzinga/v1/analyst-insights`; + getCryptoSnapshotTickers: async (tickers?: Array, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/v2/snapshot/locale/global/markets/crypto/tickers`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -13258,410 +18885,552 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (date !== undefined) { - localVarQueryParameter['date'] = date; + if (tickers) { + localVarQueryParameter['tickers'] = tickers; } - if (dateAnyOf !== undefined) { - localVarQueryParameter['date.any_of'] = dateAnyOf; - } - if (dateGt !== undefined) { - localVarQueryParameter['date.gt'] = dateGt; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get trades for a crypto ticker symbol in a given time range. + * @summary Trades + * @param {string} cryptoTicker The ticker symbol to get trades for. + * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. + * @param {string} [timestampGte] Range by timestamp. + * @param {string} [timestampGt] Range by timestamp. + * @param {string} [timestampLte] Range by timestamp. + * @param {string} [timestampLt] Range by timestamp. + * @param {GetCryptoTradesOrderEnum} [order] Order results based on the `sort` field. + * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. + * @param {GetCryptoTradesSortEnum} [sort] Sort field used for ordering. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getCryptoTrades: async (cryptoTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetCryptoTradesOrderEnum, limit?: number, sort?: GetCryptoTradesSortEnum, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'cryptoTicker' is not null or undefined + assertParamExists('getCryptoTrades', 'cryptoTicker', cryptoTicker) + const localVarPath = `/v3/trades/{cryptoTicker}` + .replace(`{${"cryptoTicker"}}`, encodeURIComponent(String(cryptoTicker))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; } - if (dateGte !== undefined) { - localVarQueryParameter['date.gte'] = dateGte; - } + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; - if (dateLt !== undefined) { - localVarQueryParameter['date.lt'] = dateLt; - } + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (dateLte !== undefined) { - localVarQueryParameter['date.lte'] = dateLte; + if (timestamp !== undefined) { + localVarQueryParameter['timestamp'] = timestamp; } - if (ticker !== undefined) { - localVarQueryParameter['ticker'] = ticker; + if (timestampGte !== undefined) { + localVarQueryParameter['timestamp.gte'] = timestampGte; } - if (tickerAnyOf !== undefined) { - localVarQueryParameter['ticker.any_of'] = tickerAnyOf; + if (timestampGt !== undefined) { + localVarQueryParameter['timestamp.gt'] = timestampGt; } - if (tickerGt !== undefined) { - localVarQueryParameter['ticker.gt'] = tickerGt; + if (timestampLte !== undefined) { + localVarQueryParameter['timestamp.lte'] = timestampLte; } - if (tickerGte !== undefined) { - localVarQueryParameter['ticker.gte'] = tickerGte; + if (timestampLt !== undefined) { + localVarQueryParameter['timestamp.lt'] = timestampLt; } - if (tickerLt !== undefined) { - localVarQueryParameter['ticker.lt'] = tickerLt; + if (order !== undefined) { + localVarQueryParameter['order'] = order; } - if (tickerLte !== undefined) { - localVarQueryParameter['ticker.lte'] = tickerLte; + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; } - if (lastUpdated !== undefined) { - localVarQueryParameter['last_updated'] = lastUpdated; + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; } - if (lastUpdatedAnyOf !== undefined) { - localVarQueryParameter['last_updated.any_of'] = lastUpdatedAnyOf; - } - if (lastUpdatedGt !== undefined) { - localVarQueryParameter['last_updated.gt'] = lastUpdatedGt; - } + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - if (lastUpdatedGte !== undefined) { - localVarQueryParameter['last_updated.gte'] = lastUpdatedGte; + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Global cryptocurrency exchanges and digital asset trading platforms, including major centralized exchanges (Coinbase, Binance, Bitfinex, etc.) that facilitate trading of cryptocurrencies and digital tokens worldwide. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'999\'. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getCryptoV1Exchanges: async (limit?: number, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/crypto/v1/exchanges`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; } - if (lastUpdatedLt !== undefined) { - localVarQueryParameter['last_updated.lt'] = lastUpdatedLt; - } + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; - if (lastUpdatedLte !== undefined) { - localVarQueryParameter['last_updated.lte'] = lastUpdatedLte; - } + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (firm !== undefined) { - localVarQueryParameter['firm'] = firm; + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; } - if (firmAnyOf !== undefined) { - localVarQueryParameter['firm.any_of'] = firmAnyOf; - } - if (firmGt !== undefined) { - localVarQueryParameter['firm.gt'] = firmGt; - } + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - if (firmGte !== undefined) { - localVarQueryParameter['firm.gte'] = firmGte; + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get currency conversions using the latest market conversion rates. Note than you can convert in both directions. For example USD to CAD or CAD to USD. + * @summary Real-time Currency Conversion + * @param {string} from The \"from\" symbol of the pair. + * @param {string} to The \"to\" symbol of the pair. + * @param {number} [amount] The amount to convert, with a decimal. + * @param {GetCurrencyConversionPrecisionEnum} [precision] The decimal precision of the conversion. Defaults to 2 which is 2 decimal places accuracy. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getCurrencyConversion: async (from: string, to: string, amount?: number, precision?: GetCurrencyConversionPrecisionEnum, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'from' is not null or undefined + assertParamExists('getCurrencyConversion', 'from', from) + // verify required parameter 'to' is not null or undefined + assertParamExists('getCurrencyConversion', 'to', to) + const localVarPath = `/v1/conversion/{from}/{to}` + .replace(`{${"from"}}`, encodeURIComponent(String(from))) + .replace(`{${"to"}}`, encodeURIComponent(String(to))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; } - if (firmLt !== undefined) { - localVarQueryParameter['firm.lt'] = firmLt; - } + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; - if (firmLte !== undefined) { - localVarQueryParameter['firm.lte'] = firmLte; - } + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (ratingAction !== undefined) { - localVarQueryParameter['rating_action'] = ratingAction; + if (amount !== undefined) { + localVarQueryParameter['amount'] = amount; } - if (ratingActionAnyOf !== undefined) { - localVarQueryParameter['rating_action.any_of'] = ratingActionAnyOf; + if (precision !== undefined) { + localVarQueryParameter['precision'] = precision; } - if (ratingActionGt !== undefined) { - localVarQueryParameter['rating_action.gt'] = ratingActionGt; - } - if (ratingActionGte !== undefined) { - localVarQueryParameter['rating_action.gte'] = ratingActionGte; - } + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - if (ratingActionLt !== undefined) { - localVarQueryParameter['rating_action.lt'] = ratingActionLt; + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * ETF Global analytics data containing risk scores, reward metrics, and quantitative analysis for ETF composite tickers. + * @param {string} [compositeTicker] The stock ticker symbol used to identify this ETF product on exchanges. + * @param {string} [compositeTickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [compositeTickerGt] Filter greater than the value. + * @param {string} [compositeTickerGte] Filter greater than or equal to the value. + * @param {string} [compositeTickerLt] Filter less than the value. + * @param {string} [compositeTickerLte] Filter less than or equal to the value. + * @param {string} [processedDate] The date showing when ETF Global received and processed the data. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDate] The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {number} [riskTotalScore] ETF Global\'s proprietary Red Diamond overall risk assessment score for the ETF. Value must be a floating point number. + * @param {number} [riskTotalScoreGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [riskTotalScoreGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [riskTotalScoreLt] Filter less than the value. Value must be a floating point number. + * @param {number} [riskTotalScoreLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [rewardScore] ETF Global\'s proprietary Green Diamond score measuring the potential reward and return prospects of the ETF. Value must be a floating point number. + * @param {number} [rewardScoreGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [rewardScoreGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [rewardScoreLt] Filter less than the value. Value must be a floating point number. + * @param {number} [rewardScoreLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quantTotalScore] ETF Global\'s comprehensive quantitative analysis score combining all quantitative factors. Value must be a floating point number. + * @param {number} [quantTotalScoreGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantTotalScoreGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantTotalScoreLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantTotalScoreLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {string} [quantGrade] Letter grade summarizing the ETF\'s overall quantitative assessment, where A = 71-100, B = 56-70, etc. + * @param {string} [quantGradeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [quantGradeGt] Filter greater than the value. + * @param {string} [quantGradeGte] Filter greater than or equal to the value. + * @param {string} [quantGradeLt] Filter less than the value. + * @param {string} [quantGradeLte] Filter less than or equal to the value. + * @param {number} [quantCompositeTechnical] Combined technical analysis score aggregating short, intermediate, and long-term technical factors. Value must be a floating point number. + * @param {number} [quantCompositeTechnicalGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantCompositeTechnicalGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeTechnicalLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantCompositeTechnicalLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeSentiment] Overall market sentiment score combining put/call ratios, short interest, and implied volatility. Value must be a floating point number. + * @param {number} [quantCompositeSentimentGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantCompositeSentimentGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeSentimentLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantCompositeSentimentLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeBehavioral] Behavioral analysis score measuring investor psychology and market behavior patterns. Value must be a floating point number. + * @param {number} [quantCompositeBehavioralGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantCompositeBehavioralGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeBehavioralLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantCompositeBehavioralLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeFundamental] Overall fundamental analysis score combining P/E, P/CF, P/B, and dividend yield metrics. Value must be a floating point number. + * @param {number} [quantCompositeFundamentalGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantCompositeFundamentalGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeFundamentalLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantCompositeFundamentalLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeGlobal] Overall global theme score combining sector and country analysis for macro investment views. Value must be a floating point number. + * @param {number} [quantCompositeGlobalGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantCompositeGlobalGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeGlobalLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantCompositeGlobalLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeQuality] Overall quality assessment score combining liquidity, diversification, and issuing firm factors. Value must be a floating point number. + * @param {number} [quantCompositeQualityGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantCompositeQualityGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeQualityLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantCompositeQualityLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'5000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'composite_ticker\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getEtfGlobalV1Analytics: async (compositeTicker?: string, compositeTickerAnyOf?: string, compositeTickerGt?: string, compositeTickerGte?: string, compositeTickerLt?: string, compositeTickerLte?: string, processedDate?: string, processedDateGt?: string, processedDateGte?: string, processedDateLt?: string, processedDateLte?: string, effectiveDate?: string, effectiveDateGt?: string, effectiveDateGte?: string, effectiveDateLt?: string, effectiveDateLte?: string, riskTotalScore?: number, riskTotalScoreGt?: number, riskTotalScoreGte?: number, riskTotalScoreLt?: number, riskTotalScoreLte?: number, rewardScore?: number, rewardScoreGt?: number, rewardScoreGte?: number, rewardScoreLt?: number, rewardScoreLte?: number, quantTotalScore?: number, quantTotalScoreGt?: number, quantTotalScoreGte?: number, quantTotalScoreLt?: number, quantTotalScoreLte?: number, quantGrade?: string, quantGradeAnyOf?: string, quantGradeGt?: string, quantGradeGte?: string, quantGradeLt?: string, quantGradeLte?: string, quantCompositeTechnical?: number, quantCompositeTechnicalGt?: number, quantCompositeTechnicalGte?: number, quantCompositeTechnicalLt?: number, quantCompositeTechnicalLte?: number, quantCompositeSentiment?: number, quantCompositeSentimentGt?: number, quantCompositeSentimentGte?: number, quantCompositeSentimentLt?: number, quantCompositeSentimentLte?: number, quantCompositeBehavioral?: number, quantCompositeBehavioralGt?: number, quantCompositeBehavioralGte?: number, quantCompositeBehavioralLt?: number, quantCompositeBehavioralLte?: number, quantCompositeFundamental?: number, quantCompositeFundamentalGt?: number, quantCompositeFundamentalGte?: number, quantCompositeFundamentalLt?: number, quantCompositeFundamentalLte?: number, quantCompositeGlobal?: number, quantCompositeGlobalGt?: number, quantCompositeGlobalGte?: number, quantCompositeGlobalLt?: number, quantCompositeGlobalLte?: number, quantCompositeQuality?: number, quantCompositeQualityGt?: number, quantCompositeQualityGte?: number, quantCompositeQualityLt?: number, quantCompositeQualityLte?: number, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/etf-global/v1/analytics`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; } - if (ratingActionLte !== undefined) { - localVarQueryParameter['rating_action.lte'] = ratingActionLte; - } + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; - if (benzingaFirmId !== undefined) { - localVarQueryParameter['benzinga_firm_id'] = benzingaFirmId; - } + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (benzingaFirmIdAnyOf !== undefined) { - localVarQueryParameter['benzinga_firm_id.any_of'] = benzingaFirmIdAnyOf; + if (compositeTicker !== undefined) { + localVarQueryParameter['composite_ticker'] = compositeTicker; } - if (benzingaFirmIdGt !== undefined) { - localVarQueryParameter['benzinga_firm_id.gt'] = benzingaFirmIdGt; + if (compositeTickerAnyOf !== undefined) { + localVarQueryParameter['composite_ticker.any_of'] = compositeTickerAnyOf; } - if (benzingaFirmIdGte !== undefined) { - localVarQueryParameter['benzinga_firm_id.gte'] = benzingaFirmIdGte; + if (compositeTickerGt !== undefined) { + localVarQueryParameter['composite_ticker.gt'] = compositeTickerGt; } - if (benzingaFirmIdLt !== undefined) { - localVarQueryParameter['benzinga_firm_id.lt'] = benzingaFirmIdLt; + if (compositeTickerGte !== undefined) { + localVarQueryParameter['composite_ticker.gte'] = compositeTickerGte; } - if (benzingaFirmIdLte !== undefined) { - localVarQueryParameter['benzinga_firm_id.lte'] = benzingaFirmIdLte; + if (compositeTickerLt !== undefined) { + localVarQueryParameter['composite_ticker.lt'] = compositeTickerLt; } - if (benzingaRatingId !== undefined) { - localVarQueryParameter['benzinga_rating_id'] = benzingaRatingId; + if (compositeTickerLte !== undefined) { + localVarQueryParameter['composite_ticker.lte'] = compositeTickerLte; } - if (benzingaRatingIdAnyOf !== undefined) { - localVarQueryParameter['benzinga_rating_id.any_of'] = benzingaRatingIdAnyOf; + if (processedDate !== undefined) { + localVarQueryParameter['processed_date'] = processedDate; } - if (benzingaRatingIdGt !== undefined) { - localVarQueryParameter['benzinga_rating_id.gt'] = benzingaRatingIdGt; + if (processedDateGt !== undefined) { + localVarQueryParameter['processed_date.gt'] = processedDateGt; } - if (benzingaRatingIdGte !== undefined) { - localVarQueryParameter['benzinga_rating_id.gte'] = benzingaRatingIdGte; + if (processedDateGte !== undefined) { + localVarQueryParameter['processed_date.gte'] = processedDateGte; } - if (benzingaRatingIdLt !== undefined) { - localVarQueryParameter['benzinga_rating_id.lt'] = benzingaRatingIdLt; + if (processedDateLt !== undefined) { + localVarQueryParameter['processed_date.lt'] = processedDateLt; } - if (benzingaRatingIdLte !== undefined) { - localVarQueryParameter['benzinga_rating_id.lte'] = benzingaRatingIdLte; + if (processedDateLte !== undefined) { + localVarQueryParameter['processed_date.lte'] = processedDateLte; } - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; + if (effectiveDate !== undefined) { + localVarQueryParameter['effective_date'] = effectiveDate; } - if (sort !== undefined) { - localVarQueryParameter['sort'] = sort; + if (effectiveDateGt !== undefined) { + localVarQueryParameter['effective_date.gt'] = effectiveDateGt; } - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * A comprehensive database of financial analysts, containing detailed performance metrics and identification information for individual analysts across various financial firms. - * @param {string} [benzingaId] The identifier used by Benzinga for this record. - * @param {string} [benzingaIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [benzingaIdGt] Filter greater than the value. - * @param {string} [benzingaIdGte] Filter greater than or equal to the value. - * @param {string} [benzingaIdLt] Filter less than the value. - * @param {string} [benzingaIdLte] Filter less than or equal to the value. - * @param {string} [benzingaFirmId] The unique identifier assigned by Benzinga to the research firm or investment bank. - * @param {string} [benzingaFirmIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [benzingaFirmIdGt] Filter greater than the value. - * @param {string} [benzingaFirmIdGte] Filter greater than or equal to the value. - * @param {string} [benzingaFirmIdLt] Filter less than the value. - * @param {string} [benzingaFirmIdLte] Filter less than or equal to the value. - * @param {string} [firmName] The name of the research firm or investment bank issuing the ratings. - * @param {string} [firmNameAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [firmNameGt] Filter greater than the value. - * @param {string} [firmNameGte] Filter greater than or equal to the value. - * @param {string} [firmNameLt] Filter less than the value. - * @param {string} [firmNameLte] Filter less than or equal to the value. - * @param {string} [fullName] The full name of the analyst associated with the ratings. - * @param {string} [fullNameAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [fullNameGt] Filter greater than the value. - * @param {string} [fullNameGte] Filter greater than or equal to the value. - * @param {string} [fullNameLt] Filter less than the value. - * @param {string} [fullNameLte] Filter less than or equal to the value. - * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. - * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'full_name\' if not specified. The sort order defaults to \'asc\' if not specified. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getBenzingaV1Analysts: async (benzingaId?: string, benzingaIdAnyOf?: string, benzingaIdGt?: string, benzingaIdGte?: string, benzingaIdLt?: string, benzingaIdLte?: string, benzingaFirmId?: string, benzingaFirmIdAnyOf?: string, benzingaFirmIdGt?: string, benzingaFirmIdGte?: string, benzingaFirmIdLt?: string, benzingaFirmIdLte?: string, firmName?: string, firmNameAnyOf?: string, firmNameGt?: string, firmNameGte?: string, firmNameLt?: string, firmNameLte?: string, fullName?: string, fullNameAnyOf?: string, fullNameGt?: string, fullNameGte?: string, fullNameLt?: string, fullNameLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/benzinga/v1/analysts`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; + + if (effectiveDateGte !== undefined) { + localVarQueryParameter['effective_date.gte'] = effectiveDateGte; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; + if (effectiveDateLt !== undefined) { + localVarQueryParameter['effective_date.lt'] = effectiveDateLt; + } - // authentication apiKey required - await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (effectiveDateLte !== undefined) { + localVarQueryParameter['effective_date.lte'] = effectiveDateLte; + } - if (benzingaId !== undefined) { - localVarQueryParameter['benzinga_id'] = benzingaId; + if (riskTotalScore !== undefined) { + localVarQueryParameter['risk_total_score'] = riskTotalScore; } - if (benzingaIdAnyOf !== undefined) { - localVarQueryParameter['benzinga_id.any_of'] = benzingaIdAnyOf; + if (riskTotalScoreGt !== undefined) { + localVarQueryParameter['risk_total_score.gt'] = riskTotalScoreGt; } - if (benzingaIdGt !== undefined) { - localVarQueryParameter['benzinga_id.gt'] = benzingaIdGt; + if (riskTotalScoreGte !== undefined) { + localVarQueryParameter['risk_total_score.gte'] = riskTotalScoreGte; } - if (benzingaIdGte !== undefined) { - localVarQueryParameter['benzinga_id.gte'] = benzingaIdGte; + if (riskTotalScoreLt !== undefined) { + localVarQueryParameter['risk_total_score.lt'] = riskTotalScoreLt; } - if (benzingaIdLt !== undefined) { - localVarQueryParameter['benzinga_id.lt'] = benzingaIdLt; + if (riskTotalScoreLte !== undefined) { + localVarQueryParameter['risk_total_score.lte'] = riskTotalScoreLte; } - if (benzingaIdLte !== undefined) { - localVarQueryParameter['benzinga_id.lte'] = benzingaIdLte; + if (rewardScore !== undefined) { + localVarQueryParameter['reward_score'] = rewardScore; } - if (benzingaFirmId !== undefined) { - localVarQueryParameter['benzinga_firm_id'] = benzingaFirmId; + if (rewardScoreGt !== undefined) { + localVarQueryParameter['reward_score.gt'] = rewardScoreGt; } - if (benzingaFirmIdAnyOf !== undefined) { - localVarQueryParameter['benzinga_firm_id.any_of'] = benzingaFirmIdAnyOf; + if (rewardScoreGte !== undefined) { + localVarQueryParameter['reward_score.gte'] = rewardScoreGte; } - if (benzingaFirmIdGt !== undefined) { - localVarQueryParameter['benzinga_firm_id.gt'] = benzingaFirmIdGt; + if (rewardScoreLt !== undefined) { + localVarQueryParameter['reward_score.lt'] = rewardScoreLt; } - if (benzingaFirmIdGte !== undefined) { - localVarQueryParameter['benzinga_firm_id.gte'] = benzingaFirmIdGte; + if (rewardScoreLte !== undefined) { + localVarQueryParameter['reward_score.lte'] = rewardScoreLte; } - if (benzingaFirmIdLt !== undefined) { - localVarQueryParameter['benzinga_firm_id.lt'] = benzingaFirmIdLt; + if (quantTotalScore !== undefined) { + localVarQueryParameter['quant_total_score'] = quantTotalScore; } - if (benzingaFirmIdLte !== undefined) { - localVarQueryParameter['benzinga_firm_id.lte'] = benzingaFirmIdLte; + if (quantTotalScoreGt !== undefined) { + localVarQueryParameter['quant_total_score.gt'] = quantTotalScoreGt; } - if (firmName !== undefined) { - localVarQueryParameter['firm_name'] = firmName; + if (quantTotalScoreGte !== undefined) { + localVarQueryParameter['quant_total_score.gte'] = quantTotalScoreGte; } - if (firmNameAnyOf !== undefined) { - localVarQueryParameter['firm_name.any_of'] = firmNameAnyOf; + if (quantTotalScoreLt !== undefined) { + localVarQueryParameter['quant_total_score.lt'] = quantTotalScoreLt; } - if (firmNameGt !== undefined) { - localVarQueryParameter['firm_name.gt'] = firmNameGt; + if (quantTotalScoreLte !== undefined) { + localVarQueryParameter['quant_total_score.lte'] = quantTotalScoreLte; } - if (firmNameGte !== undefined) { - localVarQueryParameter['firm_name.gte'] = firmNameGte; + if (quantGrade !== undefined) { + localVarQueryParameter['quant_grade'] = quantGrade; } - if (firmNameLt !== undefined) { - localVarQueryParameter['firm_name.lt'] = firmNameLt; + if (quantGradeAnyOf !== undefined) { + localVarQueryParameter['quant_grade.any_of'] = quantGradeAnyOf; } - if (firmNameLte !== undefined) { - localVarQueryParameter['firm_name.lte'] = firmNameLte; + if (quantGradeGt !== undefined) { + localVarQueryParameter['quant_grade.gt'] = quantGradeGt; } - if (fullName !== undefined) { - localVarQueryParameter['full_name'] = fullName; + if (quantGradeGte !== undefined) { + localVarQueryParameter['quant_grade.gte'] = quantGradeGte; } - if (fullNameAnyOf !== undefined) { - localVarQueryParameter['full_name.any_of'] = fullNameAnyOf; + if (quantGradeLt !== undefined) { + localVarQueryParameter['quant_grade.lt'] = quantGradeLt; } - if (fullNameGt !== undefined) { - localVarQueryParameter['full_name.gt'] = fullNameGt; + if (quantGradeLte !== undefined) { + localVarQueryParameter['quant_grade.lte'] = quantGradeLte; } - if (fullNameGte !== undefined) { - localVarQueryParameter['full_name.gte'] = fullNameGte; + if (quantCompositeTechnical !== undefined) { + localVarQueryParameter['quant_composite_technical'] = quantCompositeTechnical; } - if (fullNameLt !== undefined) { - localVarQueryParameter['full_name.lt'] = fullNameLt; + if (quantCompositeTechnicalGt !== undefined) { + localVarQueryParameter['quant_composite_technical.gt'] = quantCompositeTechnicalGt; } - if (fullNameLte !== undefined) { - localVarQueryParameter['full_name.lte'] = fullNameLte; + if (quantCompositeTechnicalGte !== undefined) { + localVarQueryParameter['quant_composite_technical.gte'] = quantCompositeTechnicalGte; } - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; + if (quantCompositeTechnicalLt !== undefined) { + localVarQueryParameter['quant_composite_technical.lt'] = quantCompositeTechnicalLt; } - if (sort !== undefined) { - localVarQueryParameter['sort'] = sort; + if (quantCompositeTechnicalLte !== undefined) { + localVarQueryParameter['quant_composite_technical.lte'] = quantCompositeTechnicalLte; } + if (quantCompositeSentiment !== undefined) { + localVarQueryParameter['quant_composite_sentiment'] = quantCompositeSentiment; + } - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + if (quantCompositeSentimentGt !== undefined) { + localVarQueryParameter['quant_composite_sentiment.gt'] = quantCompositeSentimentGt; + } - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * A comprehensive financial consensus ratings table that aggregates analyst recommendations and price targets for individual stock tickers, capturing detailed rating breakdowns and statistical insights. - * @param {string} ticker The requested ticker. - * @param {string} [date] The publication date of the news article. - * @param {string} [dateGt] Filter greater than the value. - * @param {string} [dateGte] Filter greater than or equal to the value. - * @param {string} [dateLt] Filter less than the value. - * @param {string} [dateLte] Filter less than or equal to the value. - * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getBenzingaV1ConsensusRatings: async (ticker: string, date?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'ticker' is not null or undefined - assertParamExists('getBenzingaV1ConsensusRatings', 'ticker', ticker) - const localVarPath = `/benzinga/v1/consensus-ratings/{ticker}` - .replace(`{${"ticker"}}`, encodeURIComponent(String(ticker))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; + if (quantCompositeSentimentGte !== undefined) { + localVarQueryParameter['quant_composite_sentiment.gte'] = quantCompositeSentimentGte; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; + if (quantCompositeSentimentLt !== undefined) { + localVarQueryParameter['quant_composite_sentiment.lt'] = quantCompositeSentimentLt; + } - // authentication apiKey required - await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (quantCompositeSentimentLte !== undefined) { + localVarQueryParameter['quant_composite_sentiment.lte'] = quantCompositeSentimentLte; + } - if (date !== undefined) { - localVarQueryParameter['date'] = date; + if (quantCompositeBehavioral !== undefined) { + localVarQueryParameter['quant_composite_behavioral'] = quantCompositeBehavioral; } - if (dateGt !== undefined) { - localVarQueryParameter['date.gt'] = dateGt; + if (quantCompositeBehavioralGt !== undefined) { + localVarQueryParameter['quant_composite_behavioral.gt'] = quantCompositeBehavioralGt; } - if (dateGte !== undefined) { - localVarQueryParameter['date.gte'] = dateGte; + if (quantCompositeBehavioralGte !== undefined) { + localVarQueryParameter['quant_composite_behavioral.gte'] = quantCompositeBehavioralGte; } - if (dateLt !== undefined) { - localVarQueryParameter['date.lt'] = dateLt; + if (quantCompositeBehavioralLt !== undefined) { + localVarQueryParameter['quant_composite_behavioral.lt'] = quantCompositeBehavioralLt; } - if (dateLte !== undefined) { - localVarQueryParameter['date.lte'] = dateLte; + if (quantCompositeBehavioralLte !== undefined) { + localVarQueryParameter['quant_composite_behavioral.lte'] = quantCompositeBehavioralLte; + } + + if (quantCompositeFundamental !== undefined) { + localVarQueryParameter['quant_composite_fundamental'] = quantCompositeFundamental; + } + + if (quantCompositeFundamentalGt !== undefined) { + localVarQueryParameter['quant_composite_fundamental.gt'] = quantCompositeFundamentalGt; + } + + if (quantCompositeFundamentalGte !== undefined) { + localVarQueryParameter['quant_composite_fundamental.gte'] = quantCompositeFundamentalGte; + } + + if (quantCompositeFundamentalLt !== undefined) { + localVarQueryParameter['quant_composite_fundamental.lt'] = quantCompositeFundamentalLt; + } + + if (quantCompositeFundamentalLte !== undefined) { + localVarQueryParameter['quant_composite_fundamental.lte'] = quantCompositeFundamentalLte; + } + + if (quantCompositeGlobal !== undefined) { + localVarQueryParameter['quant_composite_global'] = quantCompositeGlobal; + } + + if (quantCompositeGlobalGt !== undefined) { + localVarQueryParameter['quant_composite_global.gt'] = quantCompositeGlobalGt; + } + + if (quantCompositeGlobalGte !== undefined) { + localVarQueryParameter['quant_composite_global.gte'] = quantCompositeGlobalGte; + } + + if (quantCompositeGlobalLt !== undefined) { + localVarQueryParameter['quant_composite_global.lt'] = quantCompositeGlobalLt; + } + + if (quantCompositeGlobalLte !== undefined) { + localVarQueryParameter['quant_composite_global.lte'] = quantCompositeGlobalLte; + } + + if (quantCompositeQuality !== undefined) { + localVarQueryParameter['quant_composite_quality'] = quantCompositeQuality; + } + + if (quantCompositeQualityGt !== undefined) { + localVarQueryParameter['quant_composite_quality.gt'] = quantCompositeQualityGt; + } + + if (quantCompositeQualityGte !== undefined) { + localVarQueryParameter['quant_composite_quality.gte'] = quantCompositeQualityGte; + } + + if (quantCompositeQualityLt !== undefined) { + localVarQueryParameter['quant_composite_quality.lt'] = quantCompositeQualityLt; + } + + if (quantCompositeQualityLte !== undefined) { + localVarQueryParameter['quant_composite_quality.lte'] = quantCompositeQualityLte; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -13674,68 +19443,60 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * This table contains earnings data from Benzinga, tracking both actual and estimated financial metrics for publicly traded companies. It includes EPS and revenue figures with surprise calculations, along with metadata like fiscal periods, company identifiers, and reporting timestamps. - * @param {string} [date] The calendar date (formatted as YYYY-MM-DD) when the earnings are scheduled or were reported. - * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [dateGt] Filter greater than the value. - * @param {string} [dateGte] Filter greater than or equal to the value. - * @param {string} [dateLt] Filter less than the value. - * @param {string} [dateLte] Filter less than or equal to the value. - * @param {string} [ticker] The stock symbol of the company reporting earnings. - * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [tickerGt] Filter greater than the value. - * @param {string} [tickerGte] Filter greater than or equal to the value. - * @param {string} [tickerLt] Filter less than the value. - * @param {string} [tickerLte] Filter less than or equal to the value. - * @param {number} [importance] A subjective indicator of the importance of the event, on a scale from 0 (lowest) to 5 (highest). Value must be an integer. - * @param {string} [importanceAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. - * @param {number} [importanceGt] Filter greater than the value. Value must be an integer. - * @param {number} [importanceGte] Filter greater than or equal to the value. Value must be an integer. - * @param {number} [importanceLt] Filter less than the value. Value must be an integer. - * @param {number} [importanceLte] Filter less than or equal to the value. Value must be an integer. - * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system. - * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [lastUpdatedGt] Filter greater than the value. - * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. - * @param {string} [lastUpdatedLt] Filter less than the value. - * @param {string} [lastUpdatedLte] Filter less than or equal to the value. - * @param {string} [dateStatus] Indicates whether the date of the earnings report has been confirmed. Possible values include: projected, confirmed. - * @param {string} [dateStatusAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [dateStatusGt] Filter greater than the value. - * @param {string} [dateStatusGte] Filter greater than or equal to the value. - * @param {string} [dateStatusLt] Filter less than the value. - * @param {string} [dateStatusLte] Filter less than or equal to the value. - * @param {number} [epsSurprisePercent] The percentage difference between the actual and estimated EPS. Value must be a floating point number. - * @param {string} [epsSurprisePercentAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number. - * @param {number} [epsSurprisePercentGt] Filter greater than the value. Value must be a floating point number. - * @param {number} [epsSurprisePercentGte] Filter greater than or equal to the value. Value must be a floating point number. - * @param {number} [epsSurprisePercentLt] Filter less than the value. Value must be a floating point number. - * @param {number} [epsSurprisePercentLte] Filter less than or equal to the value. Value must be a floating point number. - * @param {number} [revenueSurprisePercent] The percentage difference between the actual and estimated revenue. Value must be a floating point number. - * @param {string} [revenueSurprisePercentAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be a floating point number. - * @param {number} [revenueSurprisePercentGt] Filter greater than the value. Value must be a floating point number. - * @param {number} [revenueSurprisePercentGte] Filter greater than or equal to the value. Value must be a floating point number. - * @param {number} [revenueSurprisePercentLt] Filter less than the value. Value must be a floating point number. - * @param {number} [revenueSurprisePercentLte] Filter less than or equal to the value. Value must be a floating point number. - * @param {number} [fiscalYear] The fiscal year in which the earnings period falls. Value must be an integer. - * @param {string} [fiscalYearAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. - * @param {number} [fiscalYearGt] Filter greater than the value. Value must be an integer. - * @param {number} [fiscalYearGte] Filter greater than or equal to the value. Value must be an integer. - * @param {number} [fiscalYearLt] Filter less than the value. Value must be an integer. - * @param {number} [fiscalYearLte] Filter less than or equal to the value. Value must be an integer. - * @param {string} [fiscalPeriod] The fiscal period for which the earnings are reported. Examples include: Q1, Q2, H1, FY. - * @param {string} [fiscalPeriodAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [fiscalPeriodGt] Filter greater than the value. - * @param {string} [fiscalPeriodGte] Filter greater than or equal to the value. - * @param {string} [fiscalPeriodLt] Filter less than the value. - * @param {string} [fiscalPeriodLte] Filter less than or equal to the value. - * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. - * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getBenzingaV1Earnings: async (date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, importance?: number, importanceAnyOf?: string, importanceGt?: number, importanceGte?: number, importanceLt?: number, importanceLte?: number, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, dateStatus?: string, dateStatusAnyOf?: string, dateStatusGt?: string, dateStatusGte?: string, dateStatusLt?: string, dateStatusLte?: string, epsSurprisePercent?: number, epsSurprisePercentAnyOf?: string, epsSurprisePercentGt?: number, epsSurprisePercentGte?: number, epsSurprisePercentLt?: number, epsSurprisePercentLte?: number, revenueSurprisePercent?: number, revenueSurprisePercentAnyOf?: string, revenueSurprisePercentGt?: number, revenueSurprisePercentGte?: number, revenueSurprisePercentLt?: number, revenueSurprisePercentLte?: number, fiscalYear?: number, fiscalYearAnyOf?: string, fiscalYearGt?: number, fiscalYearGte?: number, fiscalYearLt?: number, fiscalYearLte?: number, fiscalPeriod?: string, fiscalPeriodAnyOf?: string, fiscalPeriodGt?: string, fiscalPeriodGte?: string, fiscalPeriodLt?: string, fiscalPeriodLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/benzinga/v1/earnings`; + * ETF Global constituents data containing detailed information about the securities held within ETFs, including weights, market values, and security identifiers. + * @param {string} [compositeTicker] The stock ticker symbol of the ETF that holds these constituent securities. + * @param {string} [compositeTickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [compositeTickerGt] Filter greater than the value. + * @param {string} [compositeTickerGte] Filter greater than or equal to the value. + * @param {string} [compositeTickerLt] Filter less than the value. + * @param {string} [compositeTickerLte] Filter less than or equal to the value. + * @param {string} [constituentTicker] The stock ticker symbol of the individual security held within the ETF. + * @param {string} [constituentTickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [constituentTickerGt] Filter greater than the value. + * @param {string} [constituentTickerGte] Filter greater than or equal to the value. + * @param {string} [constituentTickerLt] Filter less than the value. + * @param {string} [constituentTickerLte] Filter less than or equal to the value. + * @param {string} [effectiveDate] The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDate] The date showing when ETF Global received and processed the data. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [usCode] A unique identifier code for the constituent security in US markets. + * @param {string} [usCodeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [usCodeGt] Filter greater than the value. + * @param {string} [usCodeGte] Filter greater than or equal to the value. + * @param {string} [usCodeLt] Filter less than the value. + * @param {string} [usCodeLte] Filter less than or equal to the value. + * @param {string} [isin] The International Securities Identification Number, a global standard for identifying securities. + * @param {string} [isinAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [isinGt] Filter greater than the value. + * @param {string} [isinGte] Filter greater than or equal to the value. + * @param {string} [isinLt] Filter less than the value. + * @param {string} [isinLte] Filter less than or equal to the value. + * @param {string} [figi] The Financial Instrument Global Identifier, an open standard for uniquely identifying financial instruments. + * @param {string} [figiAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [figiGt] Filter greater than the value. + * @param {string} [figiGte] Filter greater than or equal to the value. + * @param {string} [figiLt] Filter less than the value. + * @param {string} [figiLte] Filter less than or equal to the value. + * @param {string} [sedol] The Stock Exchange Daily Official List code, primarily used for securities trading in the UK. + * @param {string} [sedolAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [sedolGt] Filter greater than the value. + * @param {string} [sedolGte] Filter greater than or equal to the value. + * @param {string} [sedolLt] Filter less than the value. + * @param {string} [sedolLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'5000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'composite_ticker\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getEtfGlobalV1Constituents: async (compositeTicker?: string, compositeTickerAnyOf?: string, compositeTickerGt?: string, compositeTickerGte?: string, compositeTickerLt?: string, compositeTickerLte?: string, constituentTicker?: string, constituentTickerAnyOf?: string, constituentTickerGt?: string, constituentTickerGte?: string, constituentTickerLt?: string, constituentTickerLte?: string, effectiveDate?: string, effectiveDateGt?: string, effectiveDateGte?: string, effectiveDateLt?: string, effectiveDateLte?: string, processedDate?: string, processedDateGt?: string, processedDateGte?: string, processedDateLt?: string, processedDateLte?: string, usCode?: string, usCodeAnyOf?: string, usCodeGt?: string, usCodeGte?: string, usCodeLt?: string, usCodeLte?: string, isin?: string, isinAnyOf?: string, isinGt?: string, isinGte?: string, isinLt?: string, isinLte?: string, figi?: string, figiAnyOf?: string, figiGt?: string, figiGte?: string, figiLt?: string, figiLte?: string, sedol?: string, sedolAnyOf?: string, sedolGt?: string, sedolGte?: string, sedolLt?: string, sedolLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/etf-global/v1/constituents`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -13750,220 +19511,188 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (date !== undefined) { - localVarQueryParameter['date'] = date; - } - - if (dateAnyOf !== undefined) { - localVarQueryParameter['date.any_of'] = dateAnyOf; - } - - if (dateGt !== undefined) { - localVarQueryParameter['date.gt'] = dateGt; - } - - if (dateGte !== undefined) { - localVarQueryParameter['date.gte'] = dateGte; - } - - if (dateLt !== undefined) { - localVarQueryParameter['date.lt'] = dateLt; - } - - if (dateLte !== undefined) { - localVarQueryParameter['date.lte'] = dateLte; - } - - if (ticker !== undefined) { - localVarQueryParameter['ticker'] = ticker; - } - - if (tickerAnyOf !== undefined) { - localVarQueryParameter['ticker.any_of'] = tickerAnyOf; - } - - if (tickerGt !== undefined) { - localVarQueryParameter['ticker.gt'] = tickerGt; + if (compositeTicker !== undefined) { + localVarQueryParameter['composite_ticker'] = compositeTicker; } - if (tickerGte !== undefined) { - localVarQueryParameter['ticker.gte'] = tickerGte; + if (compositeTickerAnyOf !== undefined) { + localVarQueryParameter['composite_ticker.any_of'] = compositeTickerAnyOf; } - if (tickerLt !== undefined) { - localVarQueryParameter['ticker.lt'] = tickerLt; + if (compositeTickerGt !== undefined) { + localVarQueryParameter['composite_ticker.gt'] = compositeTickerGt; } - if (tickerLte !== undefined) { - localVarQueryParameter['ticker.lte'] = tickerLte; + if (compositeTickerGte !== undefined) { + localVarQueryParameter['composite_ticker.gte'] = compositeTickerGte; } - if (importance !== undefined) { - localVarQueryParameter['importance'] = importance; + if (compositeTickerLt !== undefined) { + localVarQueryParameter['composite_ticker.lt'] = compositeTickerLt; } - if (importanceAnyOf !== undefined) { - localVarQueryParameter['importance.any_of'] = importanceAnyOf; + if (compositeTickerLte !== undefined) { + localVarQueryParameter['composite_ticker.lte'] = compositeTickerLte; } - if (importanceGt !== undefined) { - localVarQueryParameter['importance.gt'] = importanceGt; + if (constituentTicker !== undefined) { + localVarQueryParameter['constituent_ticker'] = constituentTicker; } - if (importanceGte !== undefined) { - localVarQueryParameter['importance.gte'] = importanceGte; + if (constituentTickerAnyOf !== undefined) { + localVarQueryParameter['constituent_ticker.any_of'] = constituentTickerAnyOf; } - if (importanceLt !== undefined) { - localVarQueryParameter['importance.lt'] = importanceLt; + if (constituentTickerGt !== undefined) { + localVarQueryParameter['constituent_ticker.gt'] = constituentTickerGt; } - if (importanceLte !== undefined) { - localVarQueryParameter['importance.lte'] = importanceLte; + if (constituentTickerGte !== undefined) { + localVarQueryParameter['constituent_ticker.gte'] = constituentTickerGte; } - if (lastUpdated !== undefined) { - localVarQueryParameter['last_updated'] = lastUpdated; + if (constituentTickerLt !== undefined) { + localVarQueryParameter['constituent_ticker.lt'] = constituentTickerLt; } - if (lastUpdatedAnyOf !== undefined) { - localVarQueryParameter['last_updated.any_of'] = lastUpdatedAnyOf; + if (constituentTickerLte !== undefined) { + localVarQueryParameter['constituent_ticker.lte'] = constituentTickerLte; } - if (lastUpdatedGt !== undefined) { - localVarQueryParameter['last_updated.gt'] = lastUpdatedGt; + if (effectiveDate !== undefined) { + localVarQueryParameter['effective_date'] = effectiveDate; } - if (lastUpdatedGte !== undefined) { - localVarQueryParameter['last_updated.gte'] = lastUpdatedGte; + if (effectiveDateGt !== undefined) { + localVarQueryParameter['effective_date.gt'] = effectiveDateGt; } - if (lastUpdatedLt !== undefined) { - localVarQueryParameter['last_updated.lt'] = lastUpdatedLt; + if (effectiveDateGte !== undefined) { + localVarQueryParameter['effective_date.gte'] = effectiveDateGte; } - if (lastUpdatedLte !== undefined) { - localVarQueryParameter['last_updated.lte'] = lastUpdatedLte; + if (effectiveDateLt !== undefined) { + localVarQueryParameter['effective_date.lt'] = effectiveDateLt; } - if (dateStatus !== undefined) { - localVarQueryParameter['date_status'] = dateStatus; + if (effectiveDateLte !== undefined) { + localVarQueryParameter['effective_date.lte'] = effectiveDateLte; } - if (dateStatusAnyOf !== undefined) { - localVarQueryParameter['date_status.any_of'] = dateStatusAnyOf; + if (processedDate !== undefined) { + localVarQueryParameter['processed_date'] = processedDate; } - if (dateStatusGt !== undefined) { - localVarQueryParameter['date_status.gt'] = dateStatusGt; + if (processedDateGt !== undefined) { + localVarQueryParameter['processed_date.gt'] = processedDateGt; } - if (dateStatusGte !== undefined) { - localVarQueryParameter['date_status.gte'] = dateStatusGte; + if (processedDateGte !== undefined) { + localVarQueryParameter['processed_date.gte'] = processedDateGte; } - if (dateStatusLt !== undefined) { - localVarQueryParameter['date_status.lt'] = dateStatusLt; + if (processedDateLt !== undefined) { + localVarQueryParameter['processed_date.lt'] = processedDateLt; } - if (dateStatusLte !== undefined) { - localVarQueryParameter['date_status.lte'] = dateStatusLte; + if (processedDateLte !== undefined) { + localVarQueryParameter['processed_date.lte'] = processedDateLte; } - if (epsSurprisePercent !== undefined) { - localVarQueryParameter['eps_surprise_percent'] = epsSurprisePercent; + if (usCode !== undefined) { + localVarQueryParameter['us_code'] = usCode; } - if (epsSurprisePercentAnyOf !== undefined) { - localVarQueryParameter['eps_surprise_percent.any_of'] = epsSurprisePercentAnyOf; + if (usCodeAnyOf !== undefined) { + localVarQueryParameter['us_code.any_of'] = usCodeAnyOf; } - if (epsSurprisePercentGt !== undefined) { - localVarQueryParameter['eps_surprise_percent.gt'] = epsSurprisePercentGt; + if (usCodeGt !== undefined) { + localVarQueryParameter['us_code.gt'] = usCodeGt; } - if (epsSurprisePercentGte !== undefined) { - localVarQueryParameter['eps_surprise_percent.gte'] = epsSurprisePercentGte; + if (usCodeGte !== undefined) { + localVarQueryParameter['us_code.gte'] = usCodeGte; } - if (epsSurprisePercentLt !== undefined) { - localVarQueryParameter['eps_surprise_percent.lt'] = epsSurprisePercentLt; + if (usCodeLt !== undefined) { + localVarQueryParameter['us_code.lt'] = usCodeLt; } - if (epsSurprisePercentLte !== undefined) { - localVarQueryParameter['eps_surprise_percent.lte'] = epsSurprisePercentLte; + if (usCodeLte !== undefined) { + localVarQueryParameter['us_code.lte'] = usCodeLte; } - if (revenueSurprisePercent !== undefined) { - localVarQueryParameter['revenue_surprise_percent'] = revenueSurprisePercent; + if (isin !== undefined) { + localVarQueryParameter['isin'] = isin; } - if (revenueSurprisePercentAnyOf !== undefined) { - localVarQueryParameter['revenue_surprise_percent.any_of'] = revenueSurprisePercentAnyOf; + if (isinAnyOf !== undefined) { + localVarQueryParameter['isin.any_of'] = isinAnyOf; } - if (revenueSurprisePercentGt !== undefined) { - localVarQueryParameter['revenue_surprise_percent.gt'] = revenueSurprisePercentGt; + if (isinGt !== undefined) { + localVarQueryParameter['isin.gt'] = isinGt; } - if (revenueSurprisePercentGte !== undefined) { - localVarQueryParameter['revenue_surprise_percent.gte'] = revenueSurprisePercentGte; + if (isinGte !== undefined) { + localVarQueryParameter['isin.gte'] = isinGte; } - if (revenueSurprisePercentLt !== undefined) { - localVarQueryParameter['revenue_surprise_percent.lt'] = revenueSurprisePercentLt; + if (isinLt !== undefined) { + localVarQueryParameter['isin.lt'] = isinLt; } - if (revenueSurprisePercentLte !== undefined) { - localVarQueryParameter['revenue_surprise_percent.lte'] = revenueSurprisePercentLte; + if (isinLte !== undefined) { + localVarQueryParameter['isin.lte'] = isinLte; } - if (fiscalYear !== undefined) { - localVarQueryParameter['fiscal_year'] = fiscalYear; + if (figi !== undefined) { + localVarQueryParameter['figi'] = figi; } - if (fiscalYearAnyOf !== undefined) { - localVarQueryParameter['fiscal_year.any_of'] = fiscalYearAnyOf; + if (figiAnyOf !== undefined) { + localVarQueryParameter['figi.any_of'] = figiAnyOf; } - if (fiscalYearGt !== undefined) { - localVarQueryParameter['fiscal_year.gt'] = fiscalYearGt; + if (figiGt !== undefined) { + localVarQueryParameter['figi.gt'] = figiGt; } - if (fiscalYearGte !== undefined) { - localVarQueryParameter['fiscal_year.gte'] = fiscalYearGte; + if (figiGte !== undefined) { + localVarQueryParameter['figi.gte'] = figiGte; } - if (fiscalYearLt !== undefined) { - localVarQueryParameter['fiscal_year.lt'] = fiscalYearLt; + if (figiLt !== undefined) { + localVarQueryParameter['figi.lt'] = figiLt; } - if (fiscalYearLte !== undefined) { - localVarQueryParameter['fiscal_year.lte'] = fiscalYearLte; + if (figiLte !== undefined) { + localVarQueryParameter['figi.lte'] = figiLte; } - if (fiscalPeriod !== undefined) { - localVarQueryParameter['fiscal_period'] = fiscalPeriod; + if (sedol !== undefined) { + localVarQueryParameter['sedol'] = sedol; } - if (fiscalPeriodAnyOf !== undefined) { - localVarQueryParameter['fiscal_period.any_of'] = fiscalPeriodAnyOf; + if (sedolAnyOf !== undefined) { + localVarQueryParameter['sedol.any_of'] = sedolAnyOf; } - if (fiscalPeriodGt !== undefined) { - localVarQueryParameter['fiscal_period.gt'] = fiscalPeriodGt; + if (sedolGt !== undefined) { + localVarQueryParameter['sedol.gt'] = sedolGt; } - if (fiscalPeriodGte !== undefined) { - localVarQueryParameter['fiscal_period.gte'] = fiscalPeriodGte; + if (sedolGte !== undefined) { + localVarQueryParameter['sedol.gte'] = sedolGte; } - if (fiscalPeriodLt !== undefined) { - localVarQueryParameter['fiscal_period.lt'] = fiscalPeriodLt; + if (sedolLt !== undefined) { + localVarQueryParameter['sedol.lt'] = sedolLt; } - if (fiscalPeriodLte !== undefined) { - localVarQueryParameter['fiscal_period.lte'] = fiscalPeriodLte; + if (sedolLte !== undefined) { + localVarQueryParameter['sedol.lte'] = sedolLte; } if (limit !== undefined) { @@ -13986,20 +19715,30 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * A comprehensive database of financial firms, tracking unique identifiers, names, and basic metadata for various financial institutions and research firms. - * @param {string} [benzingaId] The identifer used by Benzinga for this record. - * @param {string} [benzingaIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [benzingaIdGt] Filter greater than the value. - * @param {string} [benzingaIdGte] Filter greater than or equal to the value. - * @param {string} [benzingaIdLt] Filter less than the value. - * @param {string} [benzingaIdLte] Filter less than or equal to the value. - * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. - * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'name\' if not specified. The sort order defaults to \'asc\' if not specified. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getBenzingaV1Firms: async (benzingaId?: string, benzingaIdAnyOf?: string, benzingaIdGt?: string, benzingaIdGte?: string, benzingaIdLt?: string, benzingaIdLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/benzinga/v1/firms`; + * ETF Global fund flow data containing information about ETF share movements, net asset values, and fund flow metrics. + * @param {string} [processedDate] The date showing when ETF Global received and processed the data. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDate] The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [compositeTicker] The stock ticker symbol used to identify this ETF on exchanges. + * @param {string} [compositeTickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [compositeTickerGt] Filter greater than the value. + * @param {string} [compositeTickerGte] Filter greater than or equal to the value. + * @param {string} [compositeTickerLt] Filter less than the value. + * @param {string} [compositeTickerLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'5000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'composite_ticker\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getEtfGlobalV1FundFlows: async (processedDate?: string, processedDateGt?: string, processedDateGte?: string, processedDateLt?: string, processedDateLte?: string, effectiveDate?: string, effectiveDateGt?: string, effectiveDateGte?: string, effectiveDateLt?: string, effectiveDateLte?: string, compositeTicker?: string, compositeTickerAnyOf?: string, compositeTickerGt?: string, compositeTickerGte?: string, compositeTickerLt?: string, compositeTickerLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/etf-global/v1/fund-flows`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -14014,28 +19753,68 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (benzingaId !== undefined) { - localVarQueryParameter['benzinga_id'] = benzingaId; + if (processedDate !== undefined) { + localVarQueryParameter['processed_date'] = processedDate; } - if (benzingaIdAnyOf !== undefined) { - localVarQueryParameter['benzinga_id.any_of'] = benzingaIdAnyOf; + if (processedDateGt !== undefined) { + localVarQueryParameter['processed_date.gt'] = processedDateGt; } - if (benzingaIdGt !== undefined) { - localVarQueryParameter['benzinga_id.gt'] = benzingaIdGt; + if (processedDateGte !== undefined) { + localVarQueryParameter['processed_date.gte'] = processedDateGte; } - if (benzingaIdGte !== undefined) { - localVarQueryParameter['benzinga_id.gte'] = benzingaIdGte; + if (processedDateLt !== undefined) { + localVarQueryParameter['processed_date.lt'] = processedDateLt; } - if (benzingaIdLt !== undefined) { - localVarQueryParameter['benzinga_id.lt'] = benzingaIdLt; + if (processedDateLte !== undefined) { + localVarQueryParameter['processed_date.lte'] = processedDateLte; } - if (benzingaIdLte !== undefined) { - localVarQueryParameter['benzinga_id.lte'] = benzingaIdLte; + if (effectiveDate !== undefined) { + localVarQueryParameter['effective_date'] = effectiveDate; + } + + if (effectiveDateGt !== undefined) { + localVarQueryParameter['effective_date.gt'] = effectiveDateGt; + } + + if (effectiveDateGte !== undefined) { + localVarQueryParameter['effective_date.gte'] = effectiveDateGte; + } + + if (effectiveDateLt !== undefined) { + localVarQueryParameter['effective_date.lt'] = effectiveDateLt; + } + + if (effectiveDateLte !== undefined) { + localVarQueryParameter['effective_date.lte'] = effectiveDateLte; + } + + if (compositeTicker !== undefined) { + localVarQueryParameter['composite_ticker'] = compositeTicker; + } + + if (compositeTickerAnyOf !== undefined) { + localVarQueryParameter['composite_ticker.any_of'] = compositeTickerAnyOf; + } + + if (compositeTickerGt !== undefined) { + localVarQueryParameter['composite_ticker.gt'] = compositeTickerGt; + } + + if (compositeTickerGte !== undefined) { + localVarQueryParameter['composite_ticker.gte'] = compositeTickerGte; + } + + if (compositeTickerLt !== undefined) { + localVarQueryParameter['composite_ticker.lt'] = compositeTickerLt; + } + + if (compositeTickerLte !== undefined) { + localVarQueryParameter['composite_ticker.lte'] = compositeTickerLte; } if (limit !== undefined) { @@ -14058,56 +19837,30 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * A comprehensive database of financial guidance and earnings estimates for various companies, capturing key metrics related to earnings per share (EPS) and revenue projections across different fiscal periods. - * @param {string} [date] The calendar date (formatted as YYYY-MM-DD) when the guidance was issued. - * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [dateGt] Filter greater than the value. - * @param {string} [dateGte] Filter greater than or equal to the value. - * @param {string} [dateLt] Filter less than the value. - * @param {string} [dateLte] Filter less than or equal to the value. - * @param {string} [ticker] The stock symbol of the company issuing guidance. - * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [tickerGt] Filter greater than the value. - * @param {string} [tickerGte] Filter greater than or equal to the value. - * @param {string} [tickerLt] Filter less than the value. - * @param {string} [tickerLte] Filter less than or equal to the value. - * @param {string} [positioning] Indicates how a particular guidance value is presented relative to other figures disclosed by the company. Possible values are \'primary\' (the emphasized figure) and \'secondary\' (a supporting or alternate figure) - * @param {string} [positioningAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [positioningGt] Filter greater than the value. - * @param {string} [positioningGte] Filter greater than or equal to the value. - * @param {string} [positioningLt] Filter less than the value. - * @param {string} [positioningLte] Filter less than or equal to the value. - * @param {number} [importance] A subjective indicator of the importance of the event, on a scale from 0 (lowest) to 5 (highest). Value must be an integer. - * @param {string} [importanceAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. - * @param {number} [importanceGt] Filter greater than the value. Value must be an integer. - * @param {number} [importanceGte] Filter greater than or equal to the value. Value must be an integer. - * @param {number} [importanceLt] Filter less than the value. Value must be an integer. - * @param {number} [importanceLte] Filter less than or equal to the value. Value must be an integer. - * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system. - * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [lastUpdatedGt] Filter greater than the value. - * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. - * @param {string} [lastUpdatedLt] Filter less than the value. - * @param {string} [lastUpdatedLte] Filter less than or equal to the value. - * @param {number} [fiscalYear] The fiscal year corresponding to the period for which the guidance is issued. Value must be an integer. - * @param {string} [fiscalYearAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. - * @param {number} [fiscalYearGt] Filter greater than the value. Value must be an integer. - * @param {number} [fiscalYearGte] Filter greater than or equal to the value. Value must be an integer. - * @param {number} [fiscalYearLt] Filter less than the value. Value must be an integer. - * @param {number} [fiscalYearLte] Filter less than or equal to the value. Value must be an integer. - * @param {string} [fiscalPeriod] The fiscal quarter to which the guidance applies, such as Q1, Q2, Q3, or Q4. - * @param {string} [fiscalPeriodAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [fiscalPeriodGt] Filter greater than the value. - * @param {string} [fiscalPeriodGte] Filter greater than or equal to the value. - * @param {string} [fiscalPeriodLt] Filter less than the value. - * @param {string} [fiscalPeriodLte] Filter less than or equal to the value. - * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. - * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getBenzingaV1Guidance: async (date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, positioning?: string, positioningAnyOf?: string, positioningGt?: string, positioningGte?: string, positioningLt?: string, positioningLte?: string, importance?: number, importanceAnyOf?: string, importanceGt?: number, importanceGte?: number, importanceLt?: number, importanceLte?: number, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, fiscalYear?: number, fiscalYearAnyOf?: string, fiscalYearGt?: number, fiscalYearGte?: number, fiscalYearLt?: number, fiscalYearLte?: number, fiscalPeriod?: string, fiscalPeriodAnyOf?: string, fiscalPeriodGt?: string, fiscalPeriodGte?: string, fiscalPeriodLt?: string, fiscalPeriodLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/benzinga/v1/guidance`; + * ETF Global industry profile data containing comprehensive ETF metadata including financial metrics, operational details, and exposure information. + * @param {string} [processedDate] The date showing when ETF Global received and processed the data. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDate] The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [compositeTicker] The stock ticker symbol used to identify this ETF product on exchanges. + * @param {string} [compositeTickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [compositeTickerGt] Filter greater than the value. + * @param {string} [compositeTickerGte] Filter greater than or equal to the value. + * @param {string} [compositeTickerLt] Filter less than the value. + * @param {string} [compositeTickerLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'5000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'composite_ticker\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getEtfGlobalV1Profiles: async (processedDate?: string, processedDateGt?: string, processedDateGte?: string, processedDateLt?: string, processedDateLte?: string, effectiveDate?: string, effectiveDateGt?: string, effectiveDateGte?: string, effectiveDateLt?: string, effectiveDateLte?: string, compositeTicker?: string, compositeTickerAnyOf?: string, compositeTickerGt?: string, compositeTickerGte?: string, compositeTickerLt?: string, compositeTickerLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/etf-global/v1/profiles`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -14122,172 +19875,190 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (date !== undefined) { - localVarQueryParameter['date'] = date; - } - - if (dateAnyOf !== undefined) { - localVarQueryParameter['date.any_of'] = dateAnyOf; - } - - if (dateGt !== undefined) { - localVarQueryParameter['date.gt'] = dateGt; - } - - if (dateGte !== undefined) { - localVarQueryParameter['date.gte'] = dateGte; + if (processedDate !== undefined) { + localVarQueryParameter['processed_date'] = processedDate; } - if (dateLt !== undefined) { - localVarQueryParameter['date.lt'] = dateLt; + if (processedDateGt !== undefined) { + localVarQueryParameter['processed_date.gt'] = processedDateGt; } - if (dateLte !== undefined) { - localVarQueryParameter['date.lte'] = dateLte; + if (processedDateGte !== undefined) { + localVarQueryParameter['processed_date.gte'] = processedDateGte; } - if (ticker !== undefined) { - localVarQueryParameter['ticker'] = ticker; + if (processedDateLt !== undefined) { + localVarQueryParameter['processed_date.lt'] = processedDateLt; } - if (tickerAnyOf !== undefined) { - localVarQueryParameter['ticker.any_of'] = tickerAnyOf; + if (processedDateLte !== undefined) { + localVarQueryParameter['processed_date.lte'] = processedDateLte; } - if (tickerGt !== undefined) { - localVarQueryParameter['ticker.gt'] = tickerGt; + if (effectiveDate !== undefined) { + localVarQueryParameter['effective_date'] = effectiveDate; } - if (tickerGte !== undefined) { - localVarQueryParameter['ticker.gte'] = tickerGte; + if (effectiveDateGt !== undefined) { + localVarQueryParameter['effective_date.gt'] = effectiveDateGt; } - if (tickerLt !== undefined) { - localVarQueryParameter['ticker.lt'] = tickerLt; + if (effectiveDateGte !== undefined) { + localVarQueryParameter['effective_date.gte'] = effectiveDateGte; } - if (tickerLte !== undefined) { - localVarQueryParameter['ticker.lte'] = tickerLte; + if (effectiveDateLt !== undefined) { + localVarQueryParameter['effective_date.lt'] = effectiveDateLt; } - if (positioning !== undefined) { - localVarQueryParameter['positioning'] = positioning; + if (effectiveDateLte !== undefined) { + localVarQueryParameter['effective_date.lte'] = effectiveDateLte; } - if (positioningAnyOf !== undefined) { - localVarQueryParameter['positioning.any_of'] = positioningAnyOf; + if (compositeTicker !== undefined) { + localVarQueryParameter['composite_ticker'] = compositeTicker; } - if (positioningGt !== undefined) { - localVarQueryParameter['positioning.gt'] = positioningGt; + if (compositeTickerAnyOf !== undefined) { + localVarQueryParameter['composite_ticker.any_of'] = compositeTickerAnyOf; } - if (positioningGte !== undefined) { - localVarQueryParameter['positioning.gte'] = positioningGte; + if (compositeTickerGt !== undefined) { + localVarQueryParameter['composite_ticker.gt'] = compositeTickerGt; } - if (positioningLt !== undefined) { - localVarQueryParameter['positioning.lt'] = positioningLt; + if (compositeTickerGte !== undefined) { + localVarQueryParameter['composite_ticker.gte'] = compositeTickerGte; } - if (positioningLte !== undefined) { - localVarQueryParameter['positioning.lte'] = positioningLte; + if (compositeTickerLt !== undefined) { + localVarQueryParameter['composite_ticker.lt'] = compositeTickerLt; } - if (importance !== undefined) { - localVarQueryParameter['importance'] = importance; + if (compositeTickerLte !== undefined) { + localVarQueryParameter['composite_ticker.lte'] = compositeTickerLte; } - if (importanceAnyOf !== undefined) { - localVarQueryParameter['importance.any_of'] = importanceAnyOf; + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; } - if (importanceGt !== undefined) { - localVarQueryParameter['importance.gt'] = importanceGt; + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; } - if (importanceGte !== undefined) { - localVarQueryParameter['importance.gte'] = importanceGte; - } - if (importanceLt !== undefined) { - localVarQueryParameter['importance.lt'] = importanceLt; - } + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - if (importanceLte !== undefined) { - localVarQueryParameter['importance.lte'] = importanceLte; + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * ETF Global taxonomy data containing detailed classification and categorization information for ETFs including investment strategy, methodology, and structural characteristics. + * @param {string} [processedDate] The date showing when ETF Global received and processed the data. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDate] The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [compositeTicker] The stock ticker symbol used to identify this ETF product on exchanges. + * @param {string} [compositeTickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [compositeTickerGt] Filter greater than the value. + * @param {string} [compositeTickerGte] Filter greater than or equal to the value. + * @param {string} [compositeTickerLt] Filter less than the value. + * @param {string} [compositeTickerLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'5000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'composite_ticker\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getEtfGlobalV1Taxonomies: async (processedDate?: string, processedDateGt?: string, processedDateGte?: string, processedDateLt?: string, processedDateLte?: string, effectiveDate?: string, effectiveDateGt?: string, effectiveDateGte?: string, effectiveDateLt?: string, effectiveDateLte?: string, compositeTicker?: string, compositeTickerAnyOf?: string, compositeTickerGt?: string, compositeTickerGte?: string, compositeTickerLt?: string, compositeTickerLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/etf-global/v1/taxonomies`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; } - if (lastUpdated !== undefined) { - localVarQueryParameter['last_updated'] = lastUpdated; - } + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; - if (lastUpdatedAnyOf !== undefined) { - localVarQueryParameter['last_updated.any_of'] = lastUpdatedAnyOf; - } + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (lastUpdatedGt !== undefined) { - localVarQueryParameter['last_updated.gt'] = lastUpdatedGt; + if (processedDate !== undefined) { + localVarQueryParameter['processed_date'] = processedDate; } - if (lastUpdatedGte !== undefined) { - localVarQueryParameter['last_updated.gte'] = lastUpdatedGte; + if (processedDateGt !== undefined) { + localVarQueryParameter['processed_date.gt'] = processedDateGt; } - if (lastUpdatedLt !== undefined) { - localVarQueryParameter['last_updated.lt'] = lastUpdatedLt; + if (processedDateGte !== undefined) { + localVarQueryParameter['processed_date.gte'] = processedDateGte; } - if (lastUpdatedLte !== undefined) { - localVarQueryParameter['last_updated.lte'] = lastUpdatedLte; + if (processedDateLt !== undefined) { + localVarQueryParameter['processed_date.lt'] = processedDateLt; } - if (fiscalYear !== undefined) { - localVarQueryParameter['fiscal_year'] = fiscalYear; + if (processedDateLte !== undefined) { + localVarQueryParameter['processed_date.lte'] = processedDateLte; } - if (fiscalYearAnyOf !== undefined) { - localVarQueryParameter['fiscal_year.any_of'] = fiscalYearAnyOf; + if (effectiveDate !== undefined) { + localVarQueryParameter['effective_date'] = effectiveDate; } - if (fiscalYearGt !== undefined) { - localVarQueryParameter['fiscal_year.gt'] = fiscalYearGt; + if (effectiveDateGt !== undefined) { + localVarQueryParameter['effective_date.gt'] = effectiveDateGt; } - if (fiscalYearGte !== undefined) { - localVarQueryParameter['fiscal_year.gte'] = fiscalYearGte; + if (effectiveDateGte !== undefined) { + localVarQueryParameter['effective_date.gte'] = effectiveDateGte; } - if (fiscalYearLt !== undefined) { - localVarQueryParameter['fiscal_year.lt'] = fiscalYearLt; + if (effectiveDateLt !== undefined) { + localVarQueryParameter['effective_date.lt'] = effectiveDateLt; } - if (fiscalYearLte !== undefined) { - localVarQueryParameter['fiscal_year.lte'] = fiscalYearLte; + if (effectiveDateLte !== undefined) { + localVarQueryParameter['effective_date.lte'] = effectiveDateLte; } - if (fiscalPeriod !== undefined) { - localVarQueryParameter['fiscal_period'] = fiscalPeriod; + if (compositeTicker !== undefined) { + localVarQueryParameter['composite_ticker'] = compositeTicker; } - if (fiscalPeriodAnyOf !== undefined) { - localVarQueryParameter['fiscal_period.any_of'] = fiscalPeriodAnyOf; + if (compositeTickerAnyOf !== undefined) { + localVarQueryParameter['composite_ticker.any_of'] = compositeTickerAnyOf; } - if (fiscalPeriodGt !== undefined) { - localVarQueryParameter['fiscal_period.gt'] = fiscalPeriodGt; + if (compositeTickerGt !== undefined) { + localVarQueryParameter['composite_ticker.gt'] = compositeTickerGt; } - if (fiscalPeriodGte !== undefined) { - localVarQueryParameter['fiscal_period.gte'] = fiscalPeriodGte; + if (compositeTickerGte !== undefined) { + localVarQueryParameter['composite_ticker.gte'] = compositeTickerGte; } - if (fiscalPeriodLt !== undefined) { - localVarQueryParameter['fiscal_period.lt'] = fiscalPeriodLt; + if (compositeTickerLt !== undefined) { + localVarQueryParameter['composite_ticker.lt'] = compositeTickerLt; } - if (fiscalPeriodLte !== undefined) { - localVarQueryParameter['fiscal_period.lte'] = fiscalPeriodLte; + if (compositeTickerLte !== undefined) { + localVarQueryParameter['composite_ticker.lte'] = compositeTickerLte; } if (limit !== undefined) { @@ -14310,41 +20081,18 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * A comprehensive news article database from Benzinga, containing detailed information about financial news articles including metadata, content, and associated financial information. - * @param {string} [published] The timestamp (formatted as an ISO 8601 timestamp) when the news article was originally published. - * @param {string} [publishedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [publishedGt] Filter greater than the value. - * @param {string} [publishedGte] Filter greater than or equal to the value. - * @param {string} [publishedLt] Filter less than the value. - * @param {string} [publishedLte] Filter less than or equal to the value. - * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the news article was last updated in the system. - * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [lastUpdatedGt] Filter greater than the value. - * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. - * @param {string} [lastUpdatedLt] Filter less than the value. - * @param {string} [lastUpdatedLte] Filter less than or equal to the value. - * @param {string} [tickers] Filter for arrays that contain the value. - * @param {string} [tickersAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [tickersAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [channels] Filter for arrays that contain the value. - * @param {string} [channelsAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [channelsAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [tags] Filter for arrays that contain the value. - * @param {string} [tagsAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [tagsAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [author] The name of the journalist or entity that authored the news article. - * @param {string} [authorAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [authorGt] Filter greater than the value. - * @param {string} [authorGte] Filter greater than or equal to the value. - * @param {string} [authorLt] Filter less than the value. - * @param {string} [authorLte] Filter less than or equal to the value. - * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. - * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'published\' if not specified. The sort order defaults to \'desc\' if not specified. + * Get a timeline of events for the entity associated with the given ticker, CUSIP, or Composite FIGI. + * @summary Ticker Events + * @param {string} id Identifier of an asset, which can be a Ticker, CUSIP, or Composite FIGI. Specify a case-sensitive ticker symbol (e.g. AAPL for Apple Inc). When provided a ticker, events for the entity currently represented by that ticker are returned. To find events for entities previously associated with a ticker, obtain the relevant identifier using the [Ticker Details Endpoint](https://massive.com/docs/stocks/get_v3_reference_tickers__ticker). + * @param {string} [types] A comma-separated list of the types of event to include. Currently ticker_change is the only supported event_type. Leave blank to return all supported event_types. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getBenzingaV1News: async (published?: string, publishedAnyOf?: string, publishedGt?: string, publishedGte?: string, publishedLt?: string, publishedLte?: string, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, tickers?: string, tickersAllOf?: string, tickersAnyOf?: string, channels?: string, channelsAllOf?: string, channelsAnyOf?: string, tags?: string, tagsAllOf?: string, tagsAnyOf?: string, author?: string, authorAnyOf?: string, authorGt?: string, authorGte?: string, authorLt?: string, authorLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/benzinga/v1/news`; + getEvents: async (id: string, types?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'id' is not null or undefined + assertParamExists('getEvents', 'id', id) + const localVarPath = `/vX/reference/tickers/{id}/events` + .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -14359,112 +20107,144 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (published !== undefined) { - localVarQueryParameter['published'] = published; - } - - if (publishedAnyOf !== undefined) { - localVarQueryParameter['published.any_of'] = publishedAnyOf; - } - - if (publishedGt !== undefined) { - localVarQueryParameter['published.gt'] = publishedGt; + if (types !== undefined) { + localVarQueryParameter['types'] = types; } - if (publishedGte !== undefined) { - localVarQueryParameter['published.gte'] = publishedGte; - } - if (publishedLt !== undefined) { - localVarQueryParameter['published.lt'] = publishedLt; - } + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - if (publishedLte !== undefined) { - localVarQueryParameter['published.lte'] = publishedLte; + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * A table tracking inflation and price indices, including Consumer Price Index (CPI) and Personal Consumption Expenditures (PCE) metrics over time. + * @param {string} [date] Calendar date of the observation (YYYY‑MM‑DD). + * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [dateGt] Filter greater than the value. + * @param {string} [dateGte] Filter greater than or equal to the value. + * @param {string} [dateLt] Filter less than the value. + * @param {string} [dateLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getFedV1Inflation: async (date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/fed/v1/inflation`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; } - if (lastUpdated !== undefined) { - localVarQueryParameter['last_updated'] = lastUpdated; - } + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; - if (lastUpdatedAnyOf !== undefined) { - localVarQueryParameter['last_updated.any_of'] = lastUpdatedAnyOf; - } + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (lastUpdatedGt !== undefined) { - localVarQueryParameter['last_updated.gt'] = lastUpdatedGt; + if (date !== undefined) { + localVarQueryParameter['date'] = date; } - if (lastUpdatedGte !== undefined) { - localVarQueryParameter['last_updated.gte'] = lastUpdatedGte; + if (dateAnyOf !== undefined) { + localVarQueryParameter['date.any_of'] = dateAnyOf; } - if (lastUpdatedLt !== undefined) { - localVarQueryParameter['last_updated.lt'] = lastUpdatedLt; + if (dateGt !== undefined) { + localVarQueryParameter['date.gt'] = dateGt; } - if (lastUpdatedLte !== undefined) { - localVarQueryParameter['last_updated.lte'] = lastUpdatedLte; + if (dateGte !== undefined) { + localVarQueryParameter['date.gte'] = dateGte; } - if (tickers !== undefined) { - localVarQueryParameter['tickers'] = tickers; + if (dateLt !== undefined) { + localVarQueryParameter['date.lt'] = dateLt; } - if (tickersAllOf !== undefined) { - localVarQueryParameter['tickers.all_of'] = tickersAllOf; + if (dateLte !== undefined) { + localVarQueryParameter['date.lte'] = dateLte; } - if (tickersAnyOf !== undefined) { - localVarQueryParameter['tickers.any_of'] = tickersAnyOf; + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; } - if (channels !== undefined) { - localVarQueryParameter['channels'] = channels; + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; } - if (channelsAllOf !== undefined) { - localVarQueryParameter['channels.all_of'] = channelsAllOf; - } - if (channelsAnyOf !== undefined) { - localVarQueryParameter['channels.any_of'] = channelsAnyOf; - } + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - if (tags !== undefined) { - localVarQueryParameter['tags'] = tags; + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * A table tracking inflation expectations from both market-based and economic model perspectives across different time horizons. + * @param {string} [date] Calendar date of the observation (YYYY‑MM‑DD). + * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [dateGt] Filter greater than the value. + * @param {string} [dateGte] Filter greater than or equal to the value. + * @param {string} [dateLt] Filter less than the value. + * @param {string} [dateLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getFedV1InflationExpectations: async (date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/fed/v1/inflation-expectations`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; } - if (tagsAllOf !== undefined) { - localVarQueryParameter['tags.all_of'] = tagsAllOf; - } + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; - if (tagsAnyOf !== undefined) { - localVarQueryParameter['tags.any_of'] = tagsAnyOf; - } + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (author !== undefined) { - localVarQueryParameter['author'] = author; + if (date !== undefined) { + localVarQueryParameter['date'] = date; } - if (authorAnyOf !== undefined) { - localVarQueryParameter['author.any_of'] = authorAnyOf; + if (dateAnyOf !== undefined) { + localVarQueryParameter['date.any_of'] = dateAnyOf; } - if (authorGt !== undefined) { - localVarQueryParameter['author.gt'] = authorGt; + if (dateGt !== undefined) { + localVarQueryParameter['date.gt'] = dateGt; } - if (authorGte !== undefined) { - localVarQueryParameter['author.gte'] = authorGte; + if (dateGte !== undefined) { + localVarQueryParameter['date.gte'] = dateGte; } - if (authorLt !== undefined) { - localVarQueryParameter['author.lt'] = authorLt; + if (dateLt !== undefined) { + localVarQueryParameter['date.lt'] = dateLt; } - if (authorLte !== undefined) { - localVarQueryParameter['author.lte'] = authorLte; + if (dateLte !== undefined) { + localVarQueryParameter['date.lte'] = dateLte; } if (limit !== undefined) { @@ -14487,68 +20267,20 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * This table contains analyst ratings and price target data from investment firms, tracking rating changes (upgrades, downgrades, initiates coverage, etc.) and price target adjustments for publicly traded companies. Each record includes the analyst details, company information, current and previous ratings/targets, and metadata like timestamps and Benzinga identifiers. - * @param {string} [date] The calendar date (formatted as YYYY-MM-DD) when the rating was issued. + * A record of U.S. Treasury bond yields across various maturity periods, tracking historical interest rates from short-term to long-term government securities. + * @param {string} [date] Calendar date of the yield observation (YYYY-MM-DD). * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. * @param {string} [dateLte] Filter less than or equal to the value. - * @param {string} [ticker] The stock symbol of the company being rated. - * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [tickerGt] Filter greater than the value. - * @param {string} [tickerGte] Filter greater than or equal to the value. - * @param {string} [tickerLt] Filter less than the value. - * @param {string} [tickerLte] Filter less than or equal to the value. - * @param {number} [importance] A subjective indicator of the importance of the earnings event, on a scale from 0 (lowest) to 5 (highest). Value must be an integer. - * @param {string} [importanceAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. - * @param {number} [importanceGt] Filter greater than the value. Value must be an integer. - * @param {number} [importanceGte] Filter greater than or equal to the value. Value must be an integer. - * @param {number} [importanceLt] Filter less than the value. Value must be an integer. - * @param {number} [importanceLte] Filter less than or equal to the value. Value must be an integer. - * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system. - * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [lastUpdatedGt] Filter greater than the value. - * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. - * @param {string} [lastUpdatedLt] Filter less than the value. - * @param {string} [lastUpdatedLte] Filter less than or equal to the value. - * @param {string} [ratingAction] The description of the change in rating from the firm\'s last rating. Possible values include: downgrades, maintains, reinstates, reiterates, upgrades, assumes, initiates_coverage_on, terminates_coverage_on, removes, suspends, firm_dissolved. - * @param {string} [ratingActionAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [ratingActionGt] Filter greater than the value. - * @param {string} [ratingActionGte] Filter greater than or equal to the value. - * @param {string} [ratingActionLt] Filter less than the value. - * @param {string} [ratingActionLte] Filter less than or equal to the value. - * @param {string} [priceTargetAction] The description of the directional change in price target. Possible values include: raises, lowers, maintains, announces, sets. - * @param {string} [priceTargetActionAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [priceTargetActionGt] Filter greater than the value. - * @param {string} [priceTargetActionGte] Filter greater than or equal to the value. - * @param {string} [priceTargetActionLt] Filter less than the value. - * @param {string} [priceTargetActionLte] Filter less than or equal to the value. - * @param {string} [benzingaId] The identifer used by Benzinga for this record. - * @param {string} [benzingaIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [benzingaIdGt] Filter greater than the value. - * @param {string} [benzingaIdGte] Filter greater than or equal to the value. - * @param {string} [benzingaIdLt] Filter less than the value. - * @param {string} [benzingaIdLte] Filter less than or equal to the value. - * @param {string} [benzingaAnalystId] The identifer used by Benzinga for this analyst. - * @param {string} [benzingaAnalystIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [benzingaAnalystIdGt] Filter greater than the value. - * @param {string} [benzingaAnalystIdGte] Filter greater than or equal to the value. - * @param {string} [benzingaAnalystIdLt] Filter less than the value. - * @param {string} [benzingaAnalystIdLte] Filter less than or equal to the value. - * @param {string} [benzingaFirmId] The identifer used by Benzinga for this firm. - * @param {string} [benzingaFirmIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [benzingaFirmIdGt] Filter greater than the value. - * @param {string} [benzingaFirmIdGte] Filter greater than or equal to the value. - * @param {string} [benzingaFirmIdLt] Filter less than the value. - * @param {string} [benzingaFirmIdLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. - * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getBenzingaV1Ratings: async (date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, importance?: number, importanceAnyOf?: string, importanceGt?: number, importanceGte?: number, importanceLt?: number, importanceLte?: number, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, ratingAction?: string, ratingActionAnyOf?: string, ratingActionGt?: string, ratingActionGte?: string, ratingActionLt?: string, ratingActionLte?: string, priceTargetAction?: string, priceTargetActionAnyOf?: string, priceTargetActionGt?: string, priceTargetActionGte?: string, priceTargetActionLt?: string, priceTargetActionLte?: string, benzingaId?: string, benzingaIdAnyOf?: string, benzingaIdGt?: string, benzingaIdGte?: string, benzingaIdLt?: string, benzingaIdLte?: string, benzingaAnalystId?: string, benzingaAnalystIdAnyOf?: string, benzingaAnalystIdGt?: string, benzingaAnalystIdGte?: string, benzingaAnalystIdLt?: string, benzingaAnalystIdLte?: string, benzingaFirmId?: string, benzingaFirmIdAnyOf?: string, benzingaFirmIdGt?: string, benzingaFirmIdGte?: string, benzingaFirmIdLt?: string, benzingaFirmIdLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/benzinga/v1/ratings`; + getFedV1TreasuryYields: async (date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/fed/v1/treasury-yields`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -14587,196 +20319,353 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['date.lte'] = dateLte; } - if (ticker !== undefined) { - localVarQueryParameter['ticker'] = ticker; + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; } - if (tickerAnyOf !== undefined) { - localVarQueryParameter['ticker.any_of'] = tickerAnyOf; + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; } - if (tickerGt !== undefined) { - localVarQueryParameter['ticker.gt'] = tickerGt; - } - if (tickerGte !== undefined) { - localVarQueryParameter['ticker.gte'] = tickerGte; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get aggregate bars for a forex pair over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. + * @summary Aggregates (Bars) + * @param {string} forexTicker The ticker symbol of the currency pair. + * @param {number} multiplier The size of the timespan multiplier. + * @param {GetForexAggregatesTimespanEnum} timespan The size of the time window. + * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. + * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. + * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. + * @param {GetForexAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). + * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://massive.com/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getForexAggregates: async (forexTicker: string, multiplier: number, timespan: GetForexAggregatesTimespanEnum, from: string, to: string, adjusted?: boolean, sort?: GetForexAggregatesSortEnum, limit?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'forexTicker' is not null or undefined + assertParamExists('getForexAggregates', 'forexTicker', forexTicker) + // verify required parameter 'multiplier' is not null or undefined + assertParamExists('getForexAggregates', 'multiplier', multiplier) + // verify required parameter 'timespan' is not null or undefined + assertParamExists('getForexAggregates', 'timespan', timespan) + // verify required parameter 'from' is not null or undefined + assertParamExists('getForexAggregates', 'from', from) + // verify required parameter 'to' is not null or undefined + assertParamExists('getForexAggregates', 'to', to) + const localVarPath = `/v2/aggs/ticker/{forexTicker}/range/{multiplier}/{timespan}/{from}/{to}` + .replace(`{${"forexTicker"}}`, encodeURIComponent(String(forexTicker))) + .replace(`{${"multiplier"}}`, encodeURIComponent(String(multiplier))) + .replace(`{${"timespan"}}`, encodeURIComponent(String(timespan))) + .replace(`{${"from"}}`, encodeURIComponent(String(from))) + .replace(`{${"to"}}`, encodeURIComponent(String(to))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; } - if (tickerLt !== undefined) { - localVarQueryParameter['ticker.lt'] = tickerLt; + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + if (adjusted !== undefined) { + localVarQueryParameter['adjusted'] = adjusted; } - if (tickerLte !== undefined) { - localVarQueryParameter['ticker.lte'] = tickerLte; + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; } - if (importance !== undefined) { - localVarQueryParameter['importance'] = importance; + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; } - if (importanceAnyOf !== undefined) { - localVarQueryParameter['importance.any_of'] = importanceAnyOf; + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get the exponential moving average (EMA) for a ticker symbol over a given time range. + * @summary Exponential Moving Average (EMA) + * @param {string} fxTicker The ticker symbol for which to get exponential moving average (EMA) data. + * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. + * @param {GetForexEMATimespanEnum} [timespan] The size of the aggregate time window. + * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. + * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. + * @param {GetForexEMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close prices to calculate the exponential moving average (EMA). + * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. + * @param {GetForexEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. + * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 + * @param {string} [timestampGte] Range by timestamp. + * @param {string} [timestampGt] Range by timestamp. + * @param {string} [timestampLte] Range by timestamp. + * @param {string} [timestampLt] Range by timestamp. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getForexEMA: async (fxTicker: string, timestamp?: string, timespan?: GetForexEMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetForexEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetForexEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'fxTicker' is not null or undefined + assertParamExists('getForexEMA', 'fxTicker', fxTicker) + const localVarPath = `/v1/indicators/ema/{fxTicker}` + .replace(`{${"fxTicker"}}`, encodeURIComponent(String(fxTicker))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; } - if (importanceGt !== undefined) { - localVarQueryParameter['importance.gt'] = importanceGt; + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + if (timestamp !== undefined) { + localVarQueryParameter['timestamp'] = timestamp; } - if (importanceGte !== undefined) { - localVarQueryParameter['importance.gte'] = importanceGte; + if (timespan !== undefined) { + localVarQueryParameter['timespan'] = timespan; } - if (importanceLt !== undefined) { - localVarQueryParameter['importance.lt'] = importanceLt; + if (adjusted !== undefined) { + localVarQueryParameter['adjusted'] = adjusted; } - if (importanceLte !== undefined) { - localVarQueryParameter['importance.lte'] = importanceLte; + if (window !== undefined) { + localVarQueryParameter['window'] = window; } - if (lastUpdated !== undefined) { - localVarQueryParameter['last_updated'] = lastUpdated; + if (seriesType !== undefined) { + localVarQueryParameter['series_type'] = seriesType; } - if (lastUpdatedAnyOf !== undefined) { - localVarQueryParameter['last_updated.any_of'] = lastUpdatedAnyOf; + if (expandUnderlying !== undefined) { + localVarQueryParameter['expand_underlying'] = expandUnderlying; } - if (lastUpdatedGt !== undefined) { - localVarQueryParameter['last_updated.gt'] = lastUpdatedGt; + if (order !== undefined) { + localVarQueryParameter['order'] = order; } - if (lastUpdatedGte !== undefined) { - localVarQueryParameter['last_updated.gte'] = lastUpdatedGte; + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; } - if (lastUpdatedLt !== undefined) { - localVarQueryParameter['last_updated.lt'] = lastUpdatedLt; + if (timestampGte !== undefined) { + localVarQueryParameter['timestamp.gte'] = timestampGte; } - if (lastUpdatedLte !== undefined) { - localVarQueryParameter['last_updated.lte'] = lastUpdatedLte; + if (timestampGt !== undefined) { + localVarQueryParameter['timestamp.gt'] = timestampGt; } - if (ratingAction !== undefined) { - localVarQueryParameter['rating_action'] = ratingAction; + if (timestampLte !== undefined) { + localVarQueryParameter['timestamp.lte'] = timestampLte; } - if (ratingActionAnyOf !== undefined) { - localVarQueryParameter['rating_action.any_of'] = ratingActionAnyOf; + if (timestampLt !== undefined) { + localVarQueryParameter['timestamp.lt'] = timestampLt; } - if (ratingActionGt !== undefined) { - localVarQueryParameter['rating_action.gt'] = ratingActionGt; + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get moving average convergence/divergence (MACD) data for a ticker symbol over a given time range. + * @summary Moving Average Convergence/Divergence (MACD) + * @param {string} fxTicker The ticker symbol for which to get MACD data. + * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. + * @param {GetForexMACDTimespanEnum} [timespan] The size of the aggregate time window. + * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. + * @param {number} [shortWindow] The short window size used to calculate MACD data. + * @param {number} [longWindow] The long window size used to calculate MACD data. + * @param {number} [signalWindow] The window size used to calculate the MACD signal line. + * @param {GetForexMACDSeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the MACD. i.e. \'close\' will result in using close prices to calculate the MACD. + * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. + * @param {GetForexMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. + * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 + * @param {string} [timestampGte] Range by timestamp. + * @param {string} [timestampGt] Range by timestamp. + * @param {string} [timestampLte] Range by timestamp. + * @param {string} [timestampLt] Range by timestamp. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getForexMACD: async (fxTicker: string, timestamp?: string, timespan?: GetForexMACDTimespanEnum, adjusted?: boolean, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetForexMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetForexMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'fxTicker' is not null or undefined + assertParamExists('getForexMACD', 'fxTicker', fxTicker) + const localVarPath = `/v1/indicators/macd/{fxTicker}` + .replace(`{${"fxTicker"}}`, encodeURIComponent(String(fxTicker))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; } - if (ratingActionGte !== undefined) { - localVarQueryParameter['rating_action.gte'] = ratingActionGte; - } + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; - if (ratingActionLt !== undefined) { - localVarQueryParameter['rating_action.lt'] = ratingActionLt; - } + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (ratingActionLte !== undefined) { - localVarQueryParameter['rating_action.lte'] = ratingActionLte; + if (timestamp !== undefined) { + localVarQueryParameter['timestamp'] = timestamp; } - if (priceTargetAction !== undefined) { - localVarQueryParameter['price_target_action'] = priceTargetAction; + if (timespan !== undefined) { + localVarQueryParameter['timespan'] = timespan; } - if (priceTargetActionAnyOf !== undefined) { - localVarQueryParameter['price_target_action.any_of'] = priceTargetActionAnyOf; + if (adjusted !== undefined) { + localVarQueryParameter['adjusted'] = adjusted; } - if (priceTargetActionGt !== undefined) { - localVarQueryParameter['price_target_action.gt'] = priceTargetActionGt; + if (shortWindow !== undefined) { + localVarQueryParameter['short_window'] = shortWindow; } - if (priceTargetActionGte !== undefined) { - localVarQueryParameter['price_target_action.gte'] = priceTargetActionGte; + if (longWindow !== undefined) { + localVarQueryParameter['long_window'] = longWindow; } - if (priceTargetActionLt !== undefined) { - localVarQueryParameter['price_target_action.lt'] = priceTargetActionLt; + if (signalWindow !== undefined) { + localVarQueryParameter['signal_window'] = signalWindow; } - if (priceTargetActionLte !== undefined) { - localVarQueryParameter['price_target_action.lte'] = priceTargetActionLte; + if (seriesType !== undefined) { + localVarQueryParameter['series_type'] = seriesType; } - if (benzingaId !== undefined) { - localVarQueryParameter['benzinga_id'] = benzingaId; + if (expandUnderlying !== undefined) { + localVarQueryParameter['expand_underlying'] = expandUnderlying; } - if (benzingaIdAnyOf !== undefined) { - localVarQueryParameter['benzinga_id.any_of'] = benzingaIdAnyOf; + if (order !== undefined) { + localVarQueryParameter['order'] = order; } - if (benzingaIdGt !== undefined) { - localVarQueryParameter['benzinga_id.gt'] = benzingaIdGt; + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; } - if (benzingaIdGte !== undefined) { - localVarQueryParameter['benzinga_id.gte'] = benzingaIdGte; + if (timestampGte !== undefined) { + localVarQueryParameter['timestamp.gte'] = timestampGte; } - if (benzingaIdLt !== undefined) { - localVarQueryParameter['benzinga_id.lt'] = benzingaIdLt; + if (timestampGt !== undefined) { + localVarQueryParameter['timestamp.gt'] = timestampGt; } - if (benzingaIdLte !== undefined) { - localVarQueryParameter['benzinga_id.lte'] = benzingaIdLte; + if (timestampLte !== undefined) { + localVarQueryParameter['timestamp.lte'] = timestampLte; } - if (benzingaAnalystId !== undefined) { - localVarQueryParameter['benzinga_analyst_id'] = benzingaAnalystId; + if (timestampLt !== undefined) { + localVarQueryParameter['timestamp.lt'] = timestampLt; } - if (benzingaAnalystIdAnyOf !== undefined) { - localVarQueryParameter['benzinga_analyst_id.any_of'] = benzingaAnalystIdAnyOf; - } - if (benzingaAnalystIdGt !== undefined) { - localVarQueryParameter['benzinga_analyst_id.gt'] = benzingaAnalystIdGt; - } + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - if (benzingaAnalystIdGte !== undefined) { - localVarQueryParameter['benzinga_analyst_id.gte'] = benzingaAnalystIdGte; + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get BBO quotes for a ticker symbol in a given time range. + * @summary Quotes (BBO) + * @param {string} fxTicker The ticker symbol to get quotes for. + * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. + * @param {string} [timestampGte] Range by timestamp. + * @param {string} [timestampGt] Range by timestamp. + * @param {string} [timestampLte] Range by timestamp. + * @param {string} [timestampLt] Range by timestamp. + * @param {GetForexQuotesOrderEnum} [order] Order results based on the `sort` field. + * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. + * @param {GetForexQuotesSortEnum} [sort] Sort field used for ordering. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getForexQuotes: async (fxTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetForexQuotesOrderEnum, limit?: number, sort?: GetForexQuotesSortEnum, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'fxTicker' is not null or undefined + assertParamExists('getForexQuotes', 'fxTicker', fxTicker) + const localVarPath = `/v3/quotes/{fxTicker}` + .replace(`{${"fxTicker"}}`, encodeURIComponent(String(fxTicker))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; } - if (benzingaAnalystIdLt !== undefined) { - localVarQueryParameter['benzinga_analyst_id.lt'] = benzingaAnalystIdLt; - } + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; - if (benzingaAnalystIdLte !== undefined) { - localVarQueryParameter['benzinga_analyst_id.lte'] = benzingaAnalystIdLte; - } + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (benzingaFirmId !== undefined) { - localVarQueryParameter['benzinga_firm_id'] = benzingaFirmId; + if (timestamp !== undefined) { + localVarQueryParameter['timestamp'] = timestamp; } - if (benzingaFirmIdAnyOf !== undefined) { - localVarQueryParameter['benzinga_firm_id.any_of'] = benzingaFirmIdAnyOf; + if (timestampGte !== undefined) { + localVarQueryParameter['timestamp.gte'] = timestampGte; } - if (benzingaFirmIdGt !== undefined) { - localVarQueryParameter['benzinga_firm_id.gt'] = benzingaFirmIdGt; + if (timestampGt !== undefined) { + localVarQueryParameter['timestamp.gt'] = timestampGt; } - if (benzingaFirmIdGte !== undefined) { - localVarQueryParameter['benzinga_firm_id.gte'] = benzingaFirmIdGte; + if (timestampLte !== undefined) { + localVarQueryParameter['timestamp.lte'] = timestampLte; } - if (benzingaFirmIdLt !== undefined) { - localVarQueryParameter['benzinga_firm_id.lt'] = benzingaFirmIdLt; + if (timestampLt !== undefined) { + localVarQueryParameter['timestamp.lt'] = timestampLt; } - if (benzingaFirmIdLte !== undefined) { - localVarQueryParameter['benzinga_firm_id.lte'] = benzingaFirmIdLte; + if (order !== undefined) { + localVarQueryParameter['order'] = order; } if (limit !== undefined) { @@ -14799,36 +20688,29 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get aggregate bars for a cryptocurrency pair over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. - * @summary Aggregates (Bars) - * @param {string} cryptoTicker The ticker symbol of the currency pair. - * @param {number} multiplier The size of the timespan multiplier. - * @param {GetCryptoAggregatesTimespanEnum} timespan The size of the time window. - * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. - * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. - * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. - * @param {GetCryptoAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). - * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. + * Get the relative strength index (RSI) for a ticker symbol over a given time range. + * @summary Relative Strength Index (RSI) + * @param {string} fxTicker The ticker symbol for which to get relative strength index (RSI) data. + * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. + * @param {GetForexRSITimespanEnum} [timespan] The size of the aggregate time window. + * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. + * @param {number} [window] The window size used to calculate the relative strength index (RSI). + * @param {GetForexRSISeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close prices to calculate the relative strength index (RSI). + * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. + * @param {GetForexRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. + * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 + * @param {string} [timestampGte] Range by timestamp. + * @param {string} [timestampGt] Range by timestamp. + * @param {string} [timestampLte] Range by timestamp. + * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCryptoAggregates: async (cryptoTicker: string, multiplier: number, timespan: GetCryptoAggregatesTimespanEnum, from: string, to: string, adjusted?: boolean, sort?: GetCryptoAggregatesSortEnum, limit?: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'cryptoTicker' is not null or undefined - assertParamExists('getCryptoAggregates', 'cryptoTicker', cryptoTicker) - // verify required parameter 'multiplier' is not null or undefined - assertParamExists('getCryptoAggregates', 'multiplier', multiplier) - // verify required parameter 'timespan' is not null or undefined - assertParamExists('getCryptoAggregates', 'timespan', timespan) - // verify required parameter 'from' is not null or undefined - assertParamExists('getCryptoAggregates', 'from', from) - // verify required parameter 'to' is not null or undefined - assertParamExists('getCryptoAggregates', 'to', to) - const localVarPath = `/v2/aggs/ticker/{cryptoTicker}/range/{multiplier}/{timespan}/{from}/{to}` - .replace(`{${"cryptoTicker"}}`, encodeURIComponent(String(cryptoTicker))) - .replace(`{${"multiplier"}}`, encodeURIComponent(String(multiplier))) - .replace(`{${"timespan"}}`, encodeURIComponent(String(timespan))) - .replace(`{${"from"}}`, encodeURIComponent(String(from))) - .replace(`{${"to"}}`, encodeURIComponent(String(to))); + getForexRSI: async (fxTicker: string, timestamp?: string, timespan?: GetForexRSITimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetForexRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetForexRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'fxTicker' is not null or undefined + assertParamExists('getForexRSI', 'fxTicker', fxTicker) + const localVarPath = `/v1/indicators/rsi/{fxTicker}` + .replace(`{${"fxTicker"}}`, encodeURIComponent(String(fxTicker))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -14843,18 +20725,54 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (timestamp !== undefined) { + localVarQueryParameter['timestamp'] = timestamp; + } + + if (timespan !== undefined) { + localVarQueryParameter['timespan'] = timespan; + } + if (adjusted !== undefined) { localVarQueryParameter['adjusted'] = adjusted; } - if (sort !== undefined) { - localVarQueryParameter['sort'] = sort; + if (window !== undefined) { + localVarQueryParameter['window'] = window; + } + + if (seriesType !== undefined) { + localVarQueryParameter['series_type'] = seriesType; + } + + if (expandUnderlying !== undefined) { + localVarQueryParameter['expand_underlying'] = expandUnderlying; + } + + if (order !== undefined) { + localVarQueryParameter['order'] = order; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } + if (timestampGte !== undefined) { + localVarQueryParameter['timestamp.gte'] = timestampGte; + } + + if (timestampGt !== undefined) { + localVarQueryParameter['timestamp.gt'] = timestampGt; + } + + if (timestampLte !== undefined) { + localVarQueryParameter['timestamp.lte'] = timestampLte; + } + + if (timestampLt !== undefined) { + localVarQueryParameter['timestamp.lt'] = timestampLt; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -14867,15 +20785,16 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the exponential moving average (EMA) for a ticker symbol over a given time range. - * @summary Exponential Moving Average (EMA) - * @param {string} cryptoTicker The ticker symbol for which to get exponential moving average (EMA) data. - * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. - * @param {GetCryptoEMATimespanEnum} [timespan] The size of the aggregate time window. - * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. - * @param {GetCryptoEMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close prices to calculate the exponential moving average (EMA). + * Get the simple moving average (SMA) for a ticker symbol over a given time range. + * @summary Simple Moving Average (SMA) + * @param {string} fxTicker The ticker symbol for which to get simple moving average (SMA) data. + * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. + * @param {GetForexSMATimespanEnum} [timespan] The size of the aggregate time window. + * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. + * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. + * @param {GetForexSMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close prices to calculate the simple moving average (SMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. - * @param {GetCryptoEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. + * @param {GetForexSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. @@ -14884,11 +20803,11 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCryptoEMA: async (cryptoTicker: string, timestamp?: string, timespan?: GetCryptoEMATimespanEnum, window?: number, seriesType?: GetCryptoEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetCryptoEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'cryptoTicker' is not null or undefined - assertParamExists('getCryptoEMA', 'cryptoTicker', cryptoTicker) - const localVarPath = `/v1/indicators/ema/{cryptoTicker}` - .replace(`{${"cryptoTicker"}}`, encodeURIComponent(String(cryptoTicker))); + getForexSMA: async (fxTicker: string, timestamp?: string, timespan?: GetForexSMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetForexSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetForexSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'fxTicker' is not null or undefined + assertParamExists('getForexSMA', 'fxTicker', fxTicker) + const localVarPath = `/v1/indicators/sma/{fxTicker}` + .replace(`{${"fxTicker"}}`, encodeURIComponent(String(fxTicker))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -14911,6 +20830,10 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['timespan'] = timespan; } + if (adjusted !== undefined) { + localVarQueryParameter['adjusted'] = adjusted; + } + if (window !== undefined) { localVarQueryParameter['window'] = window; } @@ -14959,30 +20882,17 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get moving average convergence/divergence (MACD) data for a ticker symbol over a given time range. - * @summary Moving Average Convergence/Divergence (MACD) - * @param {string} cryptoTicker The ticker symbol for which to get MACD data. - * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. - * @param {GetCryptoMACDTimespanEnum} [timespan] The size of the aggregate time window. - * @param {number} [shortWindow] The short window size used to calculate MACD data. - * @param {number} [longWindow] The long window size used to calculate MACD data. - * @param {number} [signalWindow] The window size used to calculate the MACD signal line. - * @param {GetCryptoMACDSeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate MACD data. i.e. \'close\' will result in using close prices to calculate the MACD. - * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. - * @param {GetCryptoMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. - * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 - * @param {string} [timestampGte] Range by timestamp. - * @param {string} [timestampGt] Range by timestamp. - * @param {string} [timestampLte] Range by timestamp. - * @param {string} [timestampLt] Range by timestamp. + * Get the current top 20 gainers or losers of the day in forex markets.

Top gainers are those tickers whose price has increased by the highest percentage since the previous day\'s close. Top losers are those tickers whose price has decreased by the highest percentage since the previous day\'s close.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. + * @summary Gainers/Losers + * @param {GetForexSnapshotDirectionDirectionEnum} direction The direction of the snapshot results to return. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCryptoMACD: async (cryptoTicker: string, timestamp?: string, timespan?: GetCryptoMACDTimespanEnum, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetCryptoMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetCryptoMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'cryptoTicker' is not null or undefined - assertParamExists('getCryptoMACD', 'cryptoTicker', cryptoTicker) - const localVarPath = `/v1/indicators/macd/{cryptoTicker}` - .replace(`{${"cryptoTicker"}}`, encodeURIComponent(String(cryptoTicker))); + getForexSnapshotDirection: async (direction: GetForexSnapshotDirectionDirectionEnum, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'direction' is not null or undefined + assertParamExists('getForexSnapshotDirection', 'direction', direction) + const localVarPath = `/v2/snapshot/locale/global/markets/forex/{direction}` + .replace(`{${"direction"}}`, encodeURIComponent(String(direction))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -14997,56 +20907,193 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (timestamp !== undefined) { - localVarQueryParameter['timestamp'] = timestamp; + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for a single traded currency symbol.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. + * @summary Ticker + * @param {string} ticker The forex ticker. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getForexSnapshotTicker: async (ticker: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'ticker' is not null or undefined + assertParamExists('getForexSnapshotTicker', 'ticker', ticker) + const localVarPath = `/v2/snapshot/locale/global/markets/forex/tickers/{ticker}` + .replace(`{${"ticker"}}`, encodeURIComponent(String(ticker))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; } - if (timespan !== undefined) { - localVarQueryParameter['timespan'] = timespan; + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for all traded forex symbols.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST. + * @summary All Tickers + * @param {Array} [tickers] A case-sensitive comma separated list of tickers to get snapshots for. For example, C:EURUSD, C:GBPCAD, and C:AUDINR. Empty string defaults to querying all tickers. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getForexSnapshotTickers: async (tickers?: Array, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/v2/snapshot/locale/global/markets/forex/tickers`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; } - if (shortWindow !== undefined) { - localVarQueryParameter['short_window'] = shortWindow; + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + if (tickers) { + localVarQueryParameter['tickers'] = tickers; } - if (longWindow !== undefined) { - localVarQueryParameter['long_window'] = longWindow; + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Global foreign exchange (FX) trading venues and market infrastructure, including electronic trading platforms, banks, and other institutions facilitating currency pair trading worldwide. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'999\'. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getForexV1Exchanges: async (limit?: number, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/forex/v1/exchanges`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; } - if (signalWindow !== undefined) { - localVarQueryParameter['signal_window'] = signalWindow; + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; } - if (seriesType !== undefined) { - localVarQueryParameter['series_type'] = seriesType; + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get aggregates for a contract in a given time range. + * @summary Aggregates + * @param {string} ticker The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract). + * @param {string} [resolution] This sets the size of the aggregate windows. It accepts custom values that specify the granularity and the duration of the window. For example: 15mins, 30secs, 12hours, or 7days. There are maximum allowable candle sizes. For example, you can request \"1min\" to \"59mins\", but after that you will need to use \"1hr\". If you make a request for a candle size that is not supported, we will return a 400 \"Bad Request - resolution value is not allowed.\" + * @param {string} [windowStart] Specifies the start time of the aggregate (OHLC) candles you want returned (YYYY-MM-DD date or nanosecond Unix timestamp). How it works - If not provided, the API returns the most recent candles available, up to the limit you set. - If provided, the value determines which candle(s) to return. The timestamp or date is “snapped” to the start time of the matching candle interval. - You can use comparison operators to form ranges: - `window_start.gte` – greater than or equal to - `window_start.gt` – greater than - `window_start.lte` – less than or equal to - `window_start.lt` – less than Examples 1. Most recent minute candles `/vX/aggs/ESU5?resolution=1min&limit=5` 2. Daily candle for August 5, 2025 `/vX/aggs/ESU5?resolution=1day&window_start=2025-08-05` 3. Daily candles from July 1–31, 2025 `/vX/aggs/ESU5?resolution=1day&window_start.gte=2025-07-01&window_start.lte=2025-07-31` 4. 1,000 one-second candles after a specific timestamp `/vX/aggs/ESU5?resolution=1sec&window_start.gt=1751409877000000000&limit=1000` + * @param {number} [limit] The number of results to return per page (default=1000, maximum=50000, minimum=1). + * @param {string} [windowStartGte] Range by window_start. + * @param {string} [windowStartGt] Range by window_start. + * @param {string} [windowStartLte] Range by window_start. + * @param {string} [windowStartLt] Range by window_start. + * @param {GetFuturesAggregatesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getFuturesAggregates: async (ticker: string, resolution?: string, windowStart?: string, limit?: number, windowStartGte?: string, windowStartGt?: string, windowStartLte?: string, windowStartLt?: string, sort?: GetFuturesAggregatesSortEnum, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'ticker' is not null or undefined + assertParamExists('getFuturesAggregates', 'ticker', ticker) + const localVarPath = `/futures/vX/aggs/{ticker}` + .replace(`{${"ticker"}}`, encodeURIComponent(String(ticker))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; } - if (expandUnderlying !== undefined) { - localVarQueryParameter['expand_underlying'] = expandUnderlying; + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + if (resolution !== undefined) { + localVarQueryParameter['resolution'] = resolution; } - if (order !== undefined) { - localVarQueryParameter['order'] = order; + if (windowStart !== undefined) { + localVarQueryParameter['window_start'] = windowStart; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } - if (timestampGte !== undefined) { - localVarQueryParameter['timestamp.gte'] = timestampGte; + if (windowStartGte !== undefined) { + localVarQueryParameter['window_start.gte'] = windowStartGte; } - if (timestampGt !== undefined) { - localVarQueryParameter['timestamp.gt'] = timestampGt; + if (windowStartGt !== undefined) { + localVarQueryParameter['window_start.gt'] = windowStartGt; } - if (timestampLte !== undefined) { - localVarQueryParameter['timestamp.lte'] = timestampLte; + if (windowStartLte !== undefined) { + localVarQueryParameter['window_start.lte'] = windowStartLte; } - if (timestampLt !== undefined) { - localVarQueryParameter['timestamp.lt'] = timestampLt; + if (windowStartLt !== undefined) { + localVarQueryParameter['window_start.lt'] = windowStartLt; + } + + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; } @@ -15061,26 +21108,18 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the open, close prices of a cryptocurrency symbol on a certain day. - * @summary Daily Open/Close - * @param {string} from The \"from\" symbol of the pair. - * @param {string} to The \"to\" symbol of the pair. - * @param {string} date The date of the requested open/close in the format YYYY-MM-DD. - * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. + * The Contract Details endpoint returns the details for a single contract at a specific point in time. + * @summary Contract Details + * @param {string} ticker The ticker symbol of the contract to retrieve. + * @param {string} [asOf] The point-in-time of the data to be retrieved. Note that the contract data returned for a given date represents the state of that contract on that day. A date in the format YYYY-MM-DD (default=today). * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCryptoOpenClose: async (from: string, to: string, date: string, adjusted?: boolean, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'from' is not null or undefined - assertParamExists('getCryptoOpenClose', 'from', from) - // verify required parameter 'to' is not null or undefined - assertParamExists('getCryptoOpenClose', 'to', to) - // verify required parameter 'date' is not null or undefined - assertParamExists('getCryptoOpenClose', 'date', date) - const localVarPath = `/v1/open-close/crypto/{from}/{to}/{date}` - .replace(`{${"from"}}`, encodeURIComponent(String(from))) - .replace(`{${"to"}}`, encodeURIComponent(String(to))) - .replace(`{${"date"}}`, encodeURIComponent(String(date))); + getFuturesContractDetails: async (ticker: string, asOf?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'ticker' is not null or undefined + assertParamExists('getFuturesContractDetails', 'ticker', ticker) + const localVarPath = `/futures/vX/contracts/{ticker}` + .replace(`{${"ticker"}}`, encodeURIComponent(String(ticker))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -15095,8 +21134,10 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (adjusted !== undefined) { - localVarQueryParameter['adjusted'] = adjusted; + if (asOf !== undefined) { + localVarQueryParameter['as_of'] = (asOf as any instanceof Date) ? + (asOf as any).toISOString().substring(0,10) : + asOf; } @@ -15111,28 +21152,21 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the relative strength index (RSI) for a ticker symbol over a given time range. - * @summary Relative Strength Index (RSI) - * @param {string} cryptoTicker The ticker symbol for which to get relative strength index (RSI) data. - * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. - * @param {GetCryptoRSITimespanEnum} [timespan] The size of the aggregate time window. - * @param {number} [window] The window size used to calculate the relative strength index (RSI). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. - * @param {GetCryptoRSISeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close prices to calculate the relative strength index (RSI). - * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. - * @param {GetCryptoRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. - * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 - * @param {string} [timestampGte] Range by timestamp. - * @param {string} [timestampGt] Range by timestamp. - * @param {string} [timestampLte] Range by timestamp. - * @param {string} [timestampLt] Range by timestamp. + * The Contracts endpoint returns a list of futures contracts. This endpoint can be used to query for contracts based on a variety of parameters, including the contract\'s ticker, product code, first trade date, last trade date, and whether or not the contract was active on a given date. + * @summary Contracts + * @param {string} [productCode] A unique identifier for the Product a Contract belongs to. Note that multiple contracts can belong to the same product. + * @param {string} [firstTradeDate] The first day that a contract was tradeable. A date with the format YYYY-MM-DD. + * @param {string} [lastTradeDate] The last day that the contract was tradeable. A date with the format YYYY-MM-DD. + * @param {string} [asOf] Specify the point-in-time for which you want to retrieve information. Note that the contract data returned for a given date is the state of that contract as of that day. A date in the format YYYY-MM-DD (default=today). + * @param {GetFuturesContractsActiveEnum} [active] Filter for contracts based on whether or not they were tradeable at the given point in time. For example, if the date queried is greater-than or equal-to a contract\'s \'first_trade_date\' and less-than-or-equal-to its \'last_trade_date\', then the contract was active. If the date queried is greater-than-or-equal-to the contract\'s \'last_trade_date\' or less-than-or-equal-to its \'first_trade_date\', then the contract was inactive. + * @param {GetFuturesContractsTypeEnum} [type] The type of contract, one of \"all\", \"single\", or \"combo\" (default=all). + * @param {number} [limit] The number of results to return per page (default=100, max=1000, min=1). + * @param {GetFuturesContractsSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCryptoRSI: async (cryptoTicker: string, timestamp?: string, timespan?: GetCryptoRSITimespanEnum, window?: number, seriesType?: GetCryptoRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetCryptoRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'cryptoTicker' is not null or undefined - assertParamExists('getCryptoRSI', 'cryptoTicker', cryptoTicker) - const localVarPath = `/v1/indicators/rsi/{cryptoTicker}` - .replace(`{${"cryptoTicker"}}`, encodeURIComponent(String(cryptoTicker))); + getFuturesContracts: async (productCode?: string, firstTradeDate?: string, lastTradeDate?: string, asOf?: string, active?: GetFuturesContractsActiveEnum, type?: GetFuturesContractsTypeEnum, limit?: number, sort?: GetFuturesContractsSortEnum, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/futures/vX/contracts`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -15147,48 +21181,42 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (timestamp !== undefined) { - localVarQueryParameter['timestamp'] = timestamp; + if (productCode !== undefined) { + localVarQueryParameter['product_code'] = productCode; } - if (timespan !== undefined) { - localVarQueryParameter['timespan'] = timespan; + if (firstTradeDate !== undefined) { + localVarQueryParameter['first_trade_date'] = (firstTradeDate as any instanceof Date) ? + (firstTradeDate as any).toISOString().substring(0,10) : + firstTradeDate; } - if (window !== undefined) { - localVarQueryParameter['window'] = window; + if (lastTradeDate !== undefined) { + localVarQueryParameter['last_trade_date'] = (lastTradeDate as any instanceof Date) ? + (lastTradeDate as any).toISOString().substring(0,10) : + lastTradeDate; } - if (seriesType !== undefined) { - localVarQueryParameter['series_type'] = seriesType; + if (asOf !== undefined) { + localVarQueryParameter['as_of'] = (asOf as any instanceof Date) ? + (asOf as any).toISOString().substring(0,10) : + asOf; } - if (expandUnderlying !== undefined) { - localVarQueryParameter['expand_underlying'] = expandUnderlying; + if (active !== undefined) { + localVarQueryParameter['active'] = active; } - if (order !== undefined) { - localVarQueryParameter['order'] = order; + if (type !== undefined) { + localVarQueryParameter['type'] = type; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } - if (timestampGte !== undefined) { - localVarQueryParameter['timestamp.gte'] = timestampGte; - } - - if (timestampGt !== undefined) { - localVarQueryParameter['timestamp.gt'] = timestampGt; - } - - if (timestampLte !== undefined) { - localVarQueryParameter['timestamp.lte'] = timestampLte; - } - - if (timestampLt !== undefined) { - localVarQueryParameter['timestamp.lt'] = timestampLt; + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; } @@ -15203,28 +21231,17 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the simple moving average (SMA) for a ticker symbol over a given time range. - * @summary Simple Moving Average (SMA) - * @param {string} cryptoTicker The ticker symbol for which to get simple moving average (SMA) data. - * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. - * @param {GetCryptoSMATimespanEnum} [timespan] The size of the aggregate time window. - * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. - * @param {GetCryptoSMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close prices to calculate the simple moving average (SMA). - * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. - * @param {GetCryptoSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. - * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 - * @param {string} [timestampGte] Range by timestamp. - * @param {string} [timestampGt] Range by timestamp. - * @param {string} [timestampLte] Range by timestamp. - * @param {string} [timestampLt] Range by timestamp. + * The Trading-Date Based Futures Schedules API provides detailed trading schedules for all products on a specific day. This API allows you to retrieve detailed information about trading sessions, including market events like preopen, open, and closed, along with their precise timestamps. + * @summary Daily Schedules + * @param {string} [sessionEndDate] The session end date for the schedules (also known as the trading date). This is the day in CT for which the user wants to retrieve data. If left blank, this value defaults to \'today\' in Central Time. e.g. If a request is made from Pacific Time on \'2025-01-01\' at 11:00 pm with no \'session_end_date\' a default value of `2025-01-02` will be used. + * @param {string} [tradingVenue] The trading venue (MIC) of the exchange for the schedules. + * @param {number} [limit] The number of results to return per page (default=100, max=1000, min=1). + * @param {GetFuturesDailySchedulesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCryptoSMA: async (cryptoTicker: string, timestamp?: string, timespan?: GetCryptoSMATimespanEnum, window?: number, seriesType?: GetCryptoSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetCryptoSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'cryptoTicker' is not null or undefined - assertParamExists('getCryptoSMA', 'cryptoTicker', cryptoTicker) - const localVarPath = `/v1/indicators/sma/{cryptoTicker}` - .replace(`{${"cryptoTicker"}}`, encodeURIComponent(String(cryptoTicker))); + getFuturesDailySchedules: async (sessionEndDate?: string, tradingVenue?: string, limit?: number, sort?: GetFuturesDailySchedulesSortEnum, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/futures/vX/schedules`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -15239,48 +21256,22 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (timestamp !== undefined) { - localVarQueryParameter['timestamp'] = timestamp; - } - - if (timespan !== undefined) { - localVarQueryParameter['timespan'] = timespan; - } - - if (window !== undefined) { - localVarQueryParameter['window'] = window; - } - - if (seriesType !== undefined) { - localVarQueryParameter['series_type'] = seriesType; - } - - if (expandUnderlying !== undefined) { - localVarQueryParameter['expand_underlying'] = expandUnderlying; + if (sessionEndDate !== undefined) { + localVarQueryParameter['session_end_date'] = (sessionEndDate as any instanceof Date) ? + (sessionEndDate as any).toISOString().substring(0,10) : + sessionEndDate; } - if (order !== undefined) { - localVarQueryParameter['order'] = order; + if (tradingVenue !== undefined) { + localVarQueryParameter['trading_venue'] = tradingVenue; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } - if (timestampGte !== undefined) { - localVarQueryParameter['timestamp.gte'] = timestampGte; - } - - if (timestampGt !== undefined) { - localVarQueryParameter['timestamp.gt'] = timestampGt; - } - - if (timestampLte !== undefined) { - localVarQueryParameter['timestamp.lte'] = timestampLte; - } - - if (timestampLt !== undefined) { - localVarQueryParameter['timestamp.lt'] = timestampLt; + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; } @@ -15295,17 +21286,17 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the current top 20 gainers or losers of the day in cryptocurrency markets.

Top gainers are those tickers whose price has increased by the highest percentage since the previous day\'s close. Top losers are those tickers whose price has decreased by the highest percentage since the previous day\'s close.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. - * @summary Gainers/Losers - * @param {GetCryptoSnapshotDirectionDirectionEnum} direction The direction of the snapshot results to return. + * The market status endpoint returns the current status of the futures market for the given product code(s). + * @summary Market Status + * @param {string} [productCodeAnyOf] The product code(s) to return market statuses for. Multiple product codes can be specified by separating them with a comma. Currently, the limit is 250 product codes. + * @param {string} [productCode] The product code to return market statuses for. + * @param {number} [limit] The number of results to return per page (default=100, max=1000, min=1). + * @param {GetFuturesMarketStatusesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCryptoSnapshotDirection: async (direction: GetCryptoSnapshotDirectionDirectionEnum, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'direction' is not null or undefined - assertParamExists('getCryptoSnapshotDirection', 'direction', direction) - const localVarPath = `/v2/snapshot/locale/global/markets/crypto/{direction}` - .replace(`{${"direction"}}`, encodeURIComponent(String(direction))); + getFuturesMarketStatuses: async (productCodeAnyOf?: string, productCode?: string, limit?: number, sort?: GetFuturesMarketStatusesSortEnum, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/futures/vX/market-status`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -15320,42 +21311,21 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (productCodeAnyOf !== undefined) { + localVarQueryParameter['product_code.any_of'] = productCodeAnyOf; + } - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for a single traded cryptocurrency symbol.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. - * @summary Ticker - * @param {string} ticker Ticker of the snapshot - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getCryptoSnapshotTicker: async (ticker: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'ticker' is not null or undefined - assertParamExists('getCryptoSnapshotTicker', 'ticker', ticker) - const localVarPath = `/v2/snapshot/locale/global/markets/crypto/tickers/{ticker}` - .replace(`{${"ticker"}}`, encodeURIComponent(String(ticker))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; + if (productCode !== undefined) { + localVarQueryParameter['product_code'] = productCode; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } - // authentication apiKey required - await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; + } @@ -15369,14 +21339,19 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for all traded cryptocurrency symbols.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST. - * @summary All Tickers - * @param {Array} [tickers] A case-sensitive comma separated list of tickers to get snapshots for. For example, X:BTCUSD, X:ETHBTC, and X:BOBAUSD. Empty string defaults to querying all tickers. + * The Product Details endpoint returns the details for a single product as of a specific day. + * @summary Product Details + * @param {string} productCode The unique identifier for a product. + * @param {GetFuturesProductDetailsTypeEnum} [type] The type of product to return. One of \"single\" or \"combo\" (default=single). + * @param {string} [asOf] A date string in the format YYYY-MM-DD. Note that the data returned is the state of this product\'s data at that point-in-time. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCryptoSnapshotTickers: async (tickers?: Array, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/v2/snapshot/locale/global/markets/crypto/tickers`; + getFuturesProductDetails: async (productCode: string, type?: GetFuturesProductDetailsTypeEnum, asOf?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'productCode' is not null or undefined + assertParamExists('getFuturesProductDetails', 'productCode', productCode) + const localVarPath = `/futures/vX/products/{product_code}` + .replace(`{${"product_code"}}`, encodeURIComponent(String(productCode))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -15391,41 +21366,46 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (tickers) { - localVarQueryParameter['tickers'] = tickers; + if (type !== undefined) { + localVarQueryParameter['type'] = type; + } + + if (asOf !== undefined) { + localVarQueryParameter['as_of'] = (asOf as any instanceof Date) ? + (asOf as any).toISOString().substring(0,10) : + asOf; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get trades for a crypto ticker symbol in a given time range. - * @summary Trades - * @param {string} cryptoTicker The ticker symbol to get trades for. - * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. - * @param {string} [timestampGte] Range by timestamp. - * @param {string} [timestampGt] Range by timestamp. - * @param {string} [timestampLte] Range by timestamp. - * @param {string} [timestampLt] Range by timestamp. - * @param {GetCryptoTradesOrderEnum} [order] Order results based on the `sort` field. - * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. - * @param {GetCryptoTradesSortEnum} [sort] Sort field used for ordering. + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * The Product-Specific Futures Schedules API provides detailed trading schedules for a specific futures product. This API allows you to query schedules for a single product across a range of dates. Users can access comprehensive information about trading sessions, including market events such as preopen, open, and closed, along with their precise timestamps. + * @summary Product Schedules + * @param {string} productCode The product code for the futures product. + * @param {string} [sessionEndDate] The date on which the schedule\'s trading day ended (sometimes referred to as trading date). Defaults to today. Formatted as `YYYY-MM-DD`. Note that although there is no time component the day is assumed to be that day in Central Time. + * @param {number} [limit] The number of results to return per page (default=100, max=1000, min=1). + * @param {string} [sessionEndDateGte] Range by session_end_date. + * @param {string} [sessionEndDateGt] Range by session_end_date. + * @param {string} [sessionEndDateLte] Range by session_end_date. + * @param {string} [sessionEndDateLt] Range by session_end_date. + * @param {GetFuturesProductSchedulesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCryptoTrades: async (cryptoTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetCryptoTradesOrderEnum, limit?: number, sort?: GetCryptoTradesSortEnum, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'cryptoTicker' is not null or undefined - assertParamExists('getCryptoTrades', 'cryptoTicker', cryptoTicker) - const localVarPath = `/v3/trades/{cryptoTicker}` - .replace(`{${"cryptoTicker"}}`, encodeURIComponent(String(cryptoTicker))); + getFuturesProductSchedules: async (productCode: string, sessionEndDate?: string, limit?: number, sessionEndDateGte?: string, sessionEndDateGt?: string, sessionEndDateLte?: string, sessionEndDateLt?: string, sort?: GetFuturesProductSchedulesSortEnum, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'productCode' is not null or undefined + assertParamExists('getFuturesProductSchedules', 'productCode', productCode) + const localVarPath = `/futures/vX/products/{product_code}/schedules` + .replace(`{${"product_code"}}`, encodeURIComponent(String(productCode))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -15440,32 +21420,38 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (timestamp !== undefined) { - localVarQueryParameter['timestamp'] = timestamp; - } - - if (timestampGte !== undefined) { - localVarQueryParameter['timestamp.gte'] = timestampGte; + if (sessionEndDate !== undefined) { + localVarQueryParameter['session_end_date'] = (sessionEndDate as any instanceof Date) ? + (sessionEndDate as any).toISOString().substring(0,10) : + sessionEndDate; } - if (timestampGt !== undefined) { - localVarQueryParameter['timestamp.gt'] = timestampGt; + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; } - if (timestampLte !== undefined) { - localVarQueryParameter['timestamp.lte'] = timestampLte; + if (sessionEndDateGte !== undefined) { + localVarQueryParameter['session_end_date.gte'] = (sessionEndDateGte as any instanceof Date) ? + (sessionEndDateGte as any).toISOString().substring(0,10) : + sessionEndDateGte; } - if (timestampLt !== undefined) { - localVarQueryParameter['timestamp.lt'] = timestampLt; + if (sessionEndDateGt !== undefined) { + localVarQueryParameter['session_end_date.gt'] = (sessionEndDateGt as any instanceof Date) ? + (sessionEndDateGt as any).toISOString().substring(0,10) : + sessionEndDateGt; } - if (order !== undefined) { - localVarQueryParameter['order'] = order; + if (sessionEndDateLte !== undefined) { + localVarQueryParameter['session_end_date.lte'] = (sessionEndDateLte as any instanceof Date) ? + (sessionEndDateLte as any).toISOString().substring(0,10) : + sessionEndDateLte; } - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; + if (sessionEndDateLt !== undefined) { + localVarQueryParameter['session_end_date.lt'] = (sessionEndDateLt as any instanceof Date) ? + (sessionEndDateLt as any).toISOString().substring(0,10) : + sessionEndDateLt; } if (sort !== undefined) { @@ -15484,23 +21470,24 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get currency conversions using the latest market conversion rates. Note than you can convert in both directions. For example USD to CAD or CAD to USD. - * @summary Real-time Currency Conversion - * @param {string} from The \"from\" symbol of the pair. - * @param {string} to The \"to\" symbol of the pair. - * @param {number} [amount] The amount to convert, with a decimal. - * @param {GetCurrencyConversionPrecisionEnum} [precision] The decimal precision of the conversion. Defaults to 2 which is 2 decimal places accuracy. + * The Products endpoint returns a list of futures products. This endpoint can be used to query for products based on a variety of parameters, including by the product\'s name, exchange, sector, sub-sector, asset class, asset sub-class, and type. + * @summary Products + * @param {string} [name] Search for products by Product Name. This parameter supports an exact match, while a name-contains search can be performed using the `name.search` parameter. Note that the search is case-sensitive. + * @param {string} [asOf] A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about products for the specified day (default=today). + * @param {string} [tradingVenue] The trading venue (MIC) for the exchange on which the products trades. + * @param {GetFuturesProductsSectorEnum} [sector] The sector to which the products belong. + * @param {GetFuturesProductsSubSectorEnum} [subSector] The sub-sector to which the products belong. + * @param {GetFuturesProductsAssetClassEnum} [assetClass] The asset class to which the products belong. + * @param {GetFuturesProductsAssetSubClassEnum} [assetSubClass] The asset sub-class to which the products belong. + * @param {GetFuturesProductsTypeEnum} [type] The type of products to return. One of \"all\", \"single\", or \"combo\" (default=all). + * @param {number} [limit] The number of results to return per page (default=100, maximum=1000, minimum=1). + * @param {string} [nameSearch] Search by name. + * @param {GetFuturesProductsSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getCurrencyConversion: async (from: string, to: string, amount?: number, precision?: GetCurrencyConversionPrecisionEnum, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'from' is not null or undefined - assertParamExists('getCurrencyConversion', 'from', from) - // verify required parameter 'to' is not null or undefined - assertParamExists('getCurrencyConversion', 'to', to) - const localVarPath = `/v1/conversion/{from}/{to}` - .replace(`{${"from"}}`, encodeURIComponent(String(from))) - .replace(`{${"to"}}`, encodeURIComponent(String(to))); + getFuturesProducts: async (name?: string, asOf?: string, tradingVenue?: string, sector?: GetFuturesProductsSectorEnum, subSector?: GetFuturesProductsSubSectorEnum, assetClass?: GetFuturesProductsAssetClassEnum, assetSubClass?: GetFuturesProductsAssetSubClassEnum, type?: GetFuturesProductsTypeEnum, limit?: number, nameSearch?: string, sort?: GetFuturesProductsSortEnum, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/futures/vX/products`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -15515,54 +21502,50 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (amount !== undefined) { - localVarQueryParameter['amount'] = amount; + if (name !== undefined) { + localVarQueryParameter['name'] = name; } - if (precision !== undefined) { - localVarQueryParameter['precision'] = precision; + if (asOf !== undefined) { + localVarQueryParameter['as_of'] = (asOf as any instanceof Date) ? + (asOf as any).toISOString().substring(0,10) : + asOf; } + if (tradingVenue !== undefined) { + localVarQueryParameter['trading_venue'] = tradingVenue; + } - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + if (sector !== undefined) { + localVarQueryParameter['sector'] = sector; + } - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get a timeline of events for the entity associated with the given ticker, CUSIP, or Composite FIGI. - * @summary Ticker Events - * @param {string} id Identifier of an asset, which can be a Ticker, CUSIP, or Composite FIGI. Specify a case-sensitive ticker symbol (e.g. AAPL for Apple Inc). When provided a ticker, events for the entity currently represented by that ticker are returned. To find events for entities previously associated with a ticker, obtain the relevant identifier using the [Ticker Details Endpoint](https://polygon.io/docs/stocks/get_v3_reference_tickers__ticker). - * @param {string} [types] A comma-separated list of the types of event to include. Currently ticker_change is the only supported event_type. Leave blank to return all supported event_types. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getEvents: async (id: string, types?: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'id' is not null or undefined - assertParamExists('getEvents', 'id', id) - const localVarPath = `/vX/reference/tickers/{id}/events` - .replace(`{${"id"}}`, encodeURIComponent(String(id))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; + if (subSector !== undefined) { + localVarQueryParameter['sub_sector'] = subSector; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; + if (assetClass !== undefined) { + localVarQueryParameter['asset_class'] = assetClass; + } - // authentication apiKey required - await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (assetSubClass !== undefined) { + localVarQueryParameter['asset_sub_class'] = assetSubClass; + } - if (types !== undefined) { - localVarQueryParameter['types'] = types; + if (type !== undefined) { + localVarQueryParameter['type'] = type; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (nameSearch !== undefined) { + localVarQueryParameter['name.search'] = nameSearch; + } + + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; } @@ -15577,20 +21560,29 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * A table tracking inflation and price indices, including Consumer Price Index (CPI) and Personal Consumption Expenditures (PCE) metrics over time. - * @param {string} [date] Calendar date of the observation (YYYY‑MM‑DD). - * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [dateGt] Filter greater than the value. - * @param {string} [dateGte] Filter greater than or equal to the value. - * @param {string} [dateLt] Filter less than the value. - * @param {string} [dateLte] Filter less than or equal to the value. - * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. - * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'asc\' if not specified. + * Get quotes for a contract in a given time range. + * @summary Quotes + * @param {string} ticker The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract). + * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. + * @param {string} [sessionEndDate] Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format. + * @param {number} [limit] The number of results to return per page (default=1000, maximum=50000, minimum=1). + * @param {string} [timestampGte] Range by timestamp. + * @param {string} [timestampGt] Range by timestamp. + * @param {string} [timestampLte] Range by timestamp. + * @param {string} [timestampLt] Range by timestamp. + * @param {string} [sessionEndDateGte] Range by session_end_date. + * @param {string} [sessionEndDateGt] Range by session_end_date. + * @param {string} [sessionEndDateLte] Range by session_end_date. + * @param {string} [sessionEndDateLt] Range by session_end_date. + * @param {GetFuturesQuotesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFedV1Inflation: async (date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/fed/v1/inflation`; + getFuturesQuotes: async (ticker: string, timestamp?: string, sessionEndDate?: string, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, sessionEndDateGte?: string, sessionEndDateGt?: string, sessionEndDateLte?: string, sessionEndDateLt?: string, sort?: GetFuturesQuotesSortEnum, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'ticker' is not null or undefined + assertParamExists('getFuturesQuotes', 'ticker', ticker) + const localVarPath = `/futures/vX/quotes/{ticker}` + .replace(`{${"ticker"}}`, encodeURIComponent(String(ticker))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -15605,32 +21597,48 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (date !== undefined) { - localVarQueryParameter['date'] = date; + if (timestamp !== undefined) { + localVarQueryParameter['timestamp'] = timestamp; } - if (dateAnyOf !== undefined) { - localVarQueryParameter['date.any_of'] = dateAnyOf; + if (sessionEndDate !== undefined) { + localVarQueryParameter['session_end_date'] = sessionEndDate; } - if (dateGt !== undefined) { - localVarQueryParameter['date.gt'] = dateGt; + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; } - if (dateGte !== undefined) { - localVarQueryParameter['date.gte'] = dateGte; + if (timestampGte !== undefined) { + localVarQueryParameter['timestamp.gte'] = timestampGte; } - if (dateLt !== undefined) { - localVarQueryParameter['date.lt'] = dateLt; + if (timestampGt !== undefined) { + localVarQueryParameter['timestamp.gt'] = timestampGt; } - if (dateLte !== undefined) { - localVarQueryParameter['date.lte'] = dateLte; + if (timestampLte !== undefined) { + localVarQueryParameter['timestamp.lte'] = timestampLte; } - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; + if (timestampLt !== undefined) { + localVarQueryParameter['timestamp.lt'] = timestampLt; + } + + if (sessionEndDateGte !== undefined) { + localVarQueryParameter['session_end_date.gte'] = sessionEndDateGte; + } + + if (sessionEndDateGt !== undefined) { + localVarQueryParameter['session_end_date.gt'] = sessionEndDateGt; + } + + if (sessionEndDateLte !== undefined) { + localVarQueryParameter['session_end_date.lte'] = sessionEndDateLte; + } + + if (sessionEndDateLt !== undefined) { + localVarQueryParameter['session_end_date.lt'] = sessionEndDateLt; } if (sort !== undefined) { @@ -15649,20 +21657,29 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * A table tracking inflation expectations from both market-based and economic model perspectives across different time horizons. - * @param {string} [date] Calendar date of the observation (YYYY‑MM‑DD). - * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [dateGt] Filter greater than the value. - * @param {string} [dateGte] Filter greater than or equal to the value. - * @param {string} [dateLt] Filter less than the value. - * @param {string} [dateLte] Filter less than or equal to the value. - * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. - * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'asc\' if not specified. + * Get trades for a contract in a given time range. + * @summary Trades + * @param {string} ticker The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract). + * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. + * @param {string} [sessionEndDate] Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format. + * @param {number} [limit] The number of results to return per page (default=1000, maximum=50000, minimum=1). + * @param {string} [timestampGte] Range by timestamp. + * @param {string} [timestampGt] Range by timestamp. + * @param {string} [timestampLte] Range by timestamp. + * @param {string} [timestampLt] Range by timestamp. + * @param {string} [sessionEndDateGte] Range by session_end_date. + * @param {string} [sessionEndDateGt] Range by session_end_date. + * @param {string} [sessionEndDateLte] Range by session_end_date. + * @param {string} [sessionEndDateLt] Range by session_end_date. + * @param {GetFuturesTradesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFedV1InflationExpectations: async (date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/fed/v1/inflation-expectations`; + getFuturesTrades: async (ticker: string, timestamp?: string, sessionEndDate?: string, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, sessionEndDateGte?: string, sessionEndDateGt?: string, sessionEndDateLte?: string, sessionEndDateLt?: string, sort?: GetFuturesTradesSortEnum, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'ticker' is not null or undefined + assertParamExists('getFuturesTrades', 'ticker', ticker) + const localVarPath = `/futures/vX/trades/{ticker}` + .replace(`{${"ticker"}}`, encodeURIComponent(String(ticker))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -15677,32 +21694,48 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (date !== undefined) { - localVarQueryParameter['date'] = date; + if (timestamp !== undefined) { + localVarQueryParameter['timestamp'] = timestamp; } - if (dateAnyOf !== undefined) { - localVarQueryParameter['date.any_of'] = dateAnyOf; + if (sessionEndDate !== undefined) { + localVarQueryParameter['session_end_date'] = sessionEndDate; } - if (dateGt !== undefined) { - localVarQueryParameter['date.gt'] = dateGt; + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; } - if (dateGte !== undefined) { - localVarQueryParameter['date.gte'] = dateGte; + if (timestampGte !== undefined) { + localVarQueryParameter['timestamp.gte'] = timestampGte; } - if (dateLt !== undefined) { - localVarQueryParameter['date.lt'] = dateLt; + if (timestampGt !== undefined) { + localVarQueryParameter['timestamp.gt'] = timestampGt; } - if (dateLte !== undefined) { - localVarQueryParameter['date.lte'] = dateLte; + if (timestampLte !== undefined) { + localVarQueryParameter['timestamp.lte'] = timestampLte; } - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; + if (timestampLt !== undefined) { + localVarQueryParameter['timestamp.lt'] = timestampLt; + } + + if (sessionEndDateGte !== undefined) { + localVarQueryParameter['session_end_date.gte'] = sessionEndDateGte; + } + + if (sessionEndDateGt !== undefined) { + localVarQueryParameter['session_end_date.gt'] = sessionEndDateGt; + } + + if (sessionEndDateLte !== undefined) { + localVarQueryParameter['session_end_date.lte'] = sessionEndDateLte; + } + + if (sessionEndDateLt !== undefined) { + localVarQueryParameter['session_end_date.lt'] = sessionEndDateLt; } if (sort !== undefined) { @@ -15721,20 +21754,49 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * A record of U.S. Treasury bond yields across various maturity periods, tracking historical interest rates from short-term to long-term government securities. - * @param {string} [date] Calendar date of the yield observation (YYYY-MM-DD). - * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [dateGt] Filter greater than the value. - * @param {string} [dateGte] Filter greater than or equal to the value. - * @param {string} [dateLt] Filter less than the value. - * @param {string} [dateLte] Filter less than or equal to the value. - * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. - * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'asc\' if not specified. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getFedV1TreasuryYields: async (date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/fed/v1/treasury-yields`; + * Retrieve detailed information about a specific futures contract identified by its ticker. The response includes comprehensive attributes such as active status, trade dates, days to maturity, exchange code, order quantity limits, settlement date, tick sizes, and other key metrics. Users can specify a point-in-time (as_of) to view the contract\'s state on a particular date, supporting informed trading decisions and historical analysis. Use Cases: Contract specification, historical product checks, system integration, trading decision support. + * @summary futures_contracts_v1 API + * @param {string} [date] A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about products for the specified day (default=today). Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [productCode] The unique identifier for the product. + * @param {string} [productCodeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [productCodeGt] Filter greater than the value. + * @param {string} [productCodeGte] Filter greater than or equal to the value. + * @param {string} [productCodeLt] Filter less than the value. + * @param {string} [productCodeLte] Filter less than or equal to the value. + * @param {string} [ticker] The ticker for the contract. + * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickerGt] Filter greater than the value. + * @param {string} [tickerGte] Filter greater than or equal to the value. + * @param {string} [tickerLt] Filter less than the value. + * @param {string} [tickerLte] Filter less than or equal to the value. + * @param {string} [active] The contract is still trading. Value must be \'true\', \'false\', \'1\' or \'0\'. + * @param {string} [type] The type of product, one of \'single\' or \'combo\'. + * @param {string} [typeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [typeGt] Filter greater than the value. + * @param {string} [typeGte] Filter greater than or equal to the value. + * @param {string} [typeLt] Filter less than the value. + * @param {string} [typeLte] Filter less than or equal to the value. + * @param {string} [firstTradeDate] The first date the contract trades. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [firstTradeDateGt] Filter greater than the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [firstTradeDateGte] Filter greater than or equal to the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [firstTradeDateLt] Filter less than the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [firstTradeDateLte] Filter less than or equal to the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastTradeDate] The last date the contract trades. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastTradeDateGt] Filter greater than the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastTradeDateGte] Filter greater than or equal to the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastTradeDateLt] Filter less than the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastTradeDateLte] Filter less than or equal to the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'1000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'product_code\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getFuturesVXContractsNew: async (date?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, productCode?: string, productCodeAnyOf?: string, productCodeGt?: string, productCodeGte?: string, productCodeLt?: string, productCodeLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, active?: string, type?: string, typeAnyOf?: string, typeGt?: string, typeGte?: string, typeLt?: string, typeLte?: string, firstTradeDate?: string, firstTradeDateGt?: string, firstTradeDateGte?: string, firstTradeDateLt?: string, firstTradeDateLte?: string, lastTradeDate?: string, lastTradeDateGt?: string, lastTradeDateGte?: string, lastTradeDateLt?: string, lastTradeDateLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/futures/vX/contracts-new`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -15753,10 +21815,6 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['date'] = date; } - if (dateAnyOf !== undefined) { - localVarQueryParameter['date.any_of'] = dateAnyOf; - } - if (dateGt !== undefined) { localVarQueryParameter['date.gt'] = dateGt; } @@ -15773,177 +21831,165 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['date.lte'] = dateLte; } - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; + if (productCode !== undefined) { + localVarQueryParameter['product_code'] = productCode; } - if (sort !== undefined) { - localVarQueryParameter['sort'] = sort; + if (productCodeAnyOf !== undefined) { + localVarQueryParameter['product_code.any_of'] = productCodeAnyOf; } + if (productCodeGt !== undefined) { + localVarQueryParameter['product_code.gt'] = productCodeGt; + } - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + if (productCodeGte !== undefined) { + localVarQueryParameter['product_code.gte'] = productCodeGte; + } - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get aggregate bars for a forex pair over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. - * @summary Aggregates (Bars) - * @param {string} forexTicker The ticker symbol of the currency pair. - * @param {number} multiplier The size of the timespan multiplier. - * @param {GetForexAggregatesTimespanEnum} timespan The size of the time window. - * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. - * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. - * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. - * @param {GetForexAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). - * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getForexAggregates: async (forexTicker: string, multiplier: number, timespan: GetForexAggregatesTimespanEnum, from: string, to: string, adjusted?: boolean, sort?: GetForexAggregatesSortEnum, limit?: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'forexTicker' is not null or undefined - assertParamExists('getForexAggregates', 'forexTicker', forexTicker) - // verify required parameter 'multiplier' is not null or undefined - assertParamExists('getForexAggregates', 'multiplier', multiplier) - // verify required parameter 'timespan' is not null or undefined - assertParamExists('getForexAggregates', 'timespan', timespan) - // verify required parameter 'from' is not null or undefined - assertParamExists('getForexAggregates', 'from', from) - // verify required parameter 'to' is not null or undefined - assertParamExists('getForexAggregates', 'to', to) - const localVarPath = `/v2/aggs/ticker/{forexTicker}/range/{multiplier}/{timespan}/{from}/{to}` - .replace(`{${"forexTicker"}}`, encodeURIComponent(String(forexTicker))) - .replace(`{${"multiplier"}}`, encodeURIComponent(String(multiplier))) - .replace(`{${"timespan"}}`, encodeURIComponent(String(timespan))) - .replace(`{${"from"}}`, encodeURIComponent(String(from))) - .replace(`{${"to"}}`, encodeURIComponent(String(to))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; + if (productCodeLt !== undefined) { + localVarQueryParameter['product_code.lt'] = productCodeLt; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; + if (productCodeLte !== undefined) { + localVarQueryParameter['product_code.lte'] = productCodeLte; + } - // authentication apiKey required - await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (ticker !== undefined) { + localVarQueryParameter['ticker'] = ticker; + } - if (adjusted !== undefined) { - localVarQueryParameter['adjusted'] = adjusted; + if (tickerAnyOf !== undefined) { + localVarQueryParameter['ticker.any_of'] = tickerAnyOf; } - if (sort !== undefined) { - localVarQueryParameter['sort'] = sort; + if (tickerGt !== undefined) { + localVarQueryParameter['ticker.gt'] = tickerGt; } - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; + if (tickerGte !== undefined) { + localVarQueryParameter['ticker.gte'] = tickerGte; } + if (tickerLt !== undefined) { + localVarQueryParameter['ticker.lt'] = tickerLt; + } - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + if (tickerLte !== undefined) { + localVarQueryParameter['ticker.lte'] = tickerLte; + } - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get the exponential moving average (EMA) for a ticker symbol over a given time range. - * @summary Exponential Moving Average (EMA) - * @param {string} fxTicker The ticker symbol for which to get exponential moving average (EMA) data. - * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. - * @param {GetForexEMATimespanEnum} [timespan] The size of the aggregate time window. - * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. - * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. - * @param {GetForexEMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close prices to calculate the exponential moving average (EMA). - * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. - * @param {GetForexEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. - * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 - * @param {string} [timestampGte] Range by timestamp. - * @param {string} [timestampGt] Range by timestamp. - * @param {string} [timestampLte] Range by timestamp. - * @param {string} [timestampLt] Range by timestamp. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getForexEMA: async (fxTicker: string, timestamp?: string, timespan?: GetForexEMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetForexEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetForexEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'fxTicker' is not null or undefined - assertParamExists('getForexEMA', 'fxTicker', fxTicker) - const localVarPath = `/v1/indicators/ema/{fxTicker}` - .replace(`{${"fxTicker"}}`, encodeURIComponent(String(fxTicker))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; + if (active !== undefined) { + localVarQueryParameter['active'] = active; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; + if (type !== undefined) { + localVarQueryParameter['type'] = type; + } - // authentication apiKey required - await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (typeAnyOf !== undefined) { + localVarQueryParameter['type.any_of'] = typeAnyOf; + } - if (timestamp !== undefined) { - localVarQueryParameter['timestamp'] = timestamp; + if (typeGt !== undefined) { + localVarQueryParameter['type.gt'] = typeGt; } - if (timespan !== undefined) { - localVarQueryParameter['timespan'] = timespan; + if (typeGte !== undefined) { + localVarQueryParameter['type.gte'] = typeGte; } - if (adjusted !== undefined) { - localVarQueryParameter['adjusted'] = adjusted; + if (typeLt !== undefined) { + localVarQueryParameter['type.lt'] = typeLt; } - if (window !== undefined) { - localVarQueryParameter['window'] = window; + if (typeLte !== undefined) { + localVarQueryParameter['type.lte'] = typeLte; } - if (seriesType !== undefined) { - localVarQueryParameter['series_type'] = seriesType; + if (firstTradeDate !== undefined) { + localVarQueryParameter['first_trade_date'] = firstTradeDate; } - if (expandUnderlying !== undefined) { - localVarQueryParameter['expand_underlying'] = expandUnderlying; + if (firstTradeDateGt !== undefined) { + localVarQueryParameter['first_trade_date.gt'] = firstTradeDateGt; + } + + if (firstTradeDateGte !== undefined) { + localVarQueryParameter['first_trade_date.gte'] = firstTradeDateGte; + } + + if (firstTradeDateLt !== undefined) { + localVarQueryParameter['first_trade_date.lt'] = firstTradeDateLt; + } + + if (firstTradeDateLte !== undefined) { + localVarQueryParameter['first_trade_date.lte'] = firstTradeDateLte; + } + + if (lastTradeDate !== undefined) { + localVarQueryParameter['last_trade_date'] = lastTradeDate; + } + + if (lastTradeDateGt !== undefined) { + localVarQueryParameter['last_trade_date.gt'] = lastTradeDateGt; + } + + if (lastTradeDateGte !== undefined) { + localVarQueryParameter['last_trade_date.gte'] = lastTradeDateGte; + } + + if (lastTradeDateLt !== undefined) { + localVarQueryParameter['last_trade_date.lt'] = lastTradeDateLt; } - if (order !== undefined) { - localVarQueryParameter['order'] = order; + if (lastTradeDateLte !== undefined) { + localVarQueryParameter['last_trade_date.lte'] = lastTradeDateLte; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } - if (timestampGte !== undefined) { - localVarQueryParameter['timestamp.gte'] = timestampGte; + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; } - if (timestampGt !== undefined) { - localVarQueryParameter['timestamp.gt'] = timestampGt; - } - if (timestampLte !== undefined) { - localVarQueryParameter['timestamp.lte'] = timestampLte; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * US futures exchanges and trading venues including major derivatives exchanges (CME, CBOT, NYMEX, COMEX) and other futures market infrastructure for commodity, financial, and other derivative contract trading. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'999\'. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getFuturesVXExchanges: async (limit?: number, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/futures/vX/exchanges`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; } - if (timestampLt !== undefined) { - localVarQueryParameter['timestamp.lt'] = timestampLt; + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; } @@ -15958,31 +22004,62 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get moving average convergence/divergence (MACD) data for a ticker symbol over a given time range. - * @summary Moving Average Convergence/Divergence (MACD) - * @param {string} fxTicker The ticker symbol for which to get MACD data. - * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. - * @param {GetForexMACDTimespanEnum} [timespan] The size of the aggregate time window. - * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. - * @param {number} [shortWindow] The short window size used to calculate MACD data. - * @param {number} [longWindow] The long window size used to calculate MACD data. - * @param {number} [signalWindow] The window size used to calculate the MACD signal line. - * @param {GetForexMACDSeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the MACD. i.e. \'close\' will result in using close prices to calculate the MACD. - * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. - * @param {GetForexMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. - * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 - * @param {string} [timestampGte] Range by timestamp. - * @param {string} [timestampGt] Range by timestamp. - * @param {string} [timestampLte] Range by timestamp. - * @param {string} [timestampLt] Range by timestamp. + * Retrieve detailed information about a single futures product as of a specified date, including its asset class, exchange code, full product name, settlement details, pricing quotation, sector classifications, and unit of measure. Optional parameters such as product type (single or combo) and as_of allow you to capture the product’s state on a specific day, providing essential context for trading decisions and system integrations. Use Cases: Product specification, historical product checks, risk management, trading system integration. + * @summary futures_products_v1 API + * @param {string} [name] The full name of the product. + * @param {string} [nameAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [nameGt] Filter greater than the value. + * @param {string} [nameGte] Filter greater than or equal to the value. + * @param {string} [nameLt] Filter less than the value. + * @param {string} [nameLte] Filter less than or equal to the value. + * @param {string} [productCode] The unique identifier for the product. + * @param {string} [productCodeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [productCodeGt] Filter greater than the value. + * @param {string} [productCodeGte] Filter greater than or equal to the value. + * @param {string} [productCodeLt] Filter less than the value. + * @param {string} [productCodeLte] Filter less than or equal to the value. + * @param {string} [date] A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about products for the specified day (default=today). Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [sector] The sector to which the product belongs. + * @param {string} [sectorAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [sectorGt] Filter greater than the value. + * @param {string} [sectorGte] Filter greater than or equal to the value. + * @param {string} [sectorLt] Filter less than the value. + * @param {string} [sectorLte] Filter less than or equal to the value. + * @param {string} [subSector] The sub-sector to which the product belongs. + * @param {string} [subSectorAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [subSectorGt] Filter greater than the value. + * @param {string} [subSectorGte] Filter greater than or equal to the value. + * @param {string} [subSectorLt] Filter less than the value. + * @param {string} [subSectorLte] Filter less than or equal to the value. + * @param {string} [assetClass] The asset class to which the product belongs. + * @param {string} [assetClassAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [assetClassGt] Filter greater than the value. + * @param {string} [assetClassGte] Filter greater than or equal to the value. + * @param {string} [assetClassLt] Filter less than the value. + * @param {string} [assetClassLte] Filter less than or equal to the value. + * @param {string} [assetSubClass] The asset sub-class to which the product belongs. + * @param {string} [assetSubClassAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [assetSubClassGt] Filter greater than the value. + * @param {string} [assetSubClassGte] Filter greater than or equal to the value. + * @param {string} [assetSubClassLt] Filter less than the value. + * @param {string} [assetSubClassLte] Filter less than or equal to the value. + * @param {string} [type] The type of product, one of \'single\' or \'combo\'. + * @param {string} [typeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [typeGt] Filter greater than the value. + * @param {string} [typeGte] Filter greater than or equal to the value. + * @param {string} [typeLt] Filter less than the value. + * @param {string} [typeLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getForexMACD: async (fxTicker: string, timestamp?: string, timespan?: GetForexMACDTimespanEnum, adjusted?: boolean, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetForexMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetForexMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'fxTicker' is not null or undefined - assertParamExists('getForexMACD', 'fxTicker', fxTicker) - const localVarPath = `/v1/indicators/macd/{fxTicker}` - .replace(`{${"fxTicker"}}`, encodeURIComponent(String(fxTicker))); + getFuturesVXProductsNew: async (name?: string, nameAnyOf?: string, nameGt?: string, nameGte?: string, nameLt?: string, nameLte?: string, productCode?: string, productCodeAnyOf?: string, productCodeGt?: string, productCodeGte?: string, productCodeLt?: string, productCodeLte?: string, date?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, sector?: string, sectorAnyOf?: string, sectorGt?: string, sectorGte?: string, sectorLt?: string, sectorLte?: string, subSector?: string, subSectorAnyOf?: string, subSectorGt?: string, subSectorGte?: string, subSectorLt?: string, subSectorLte?: string, assetClass?: string, assetClassAnyOf?: string, assetClassGt?: string, assetClassGte?: string, assetClassLt?: string, assetClassLte?: string, assetSubClass?: string, assetSubClassAnyOf?: string, assetSubClassGt?: string, assetSubClassGte?: string, assetSubClassLt?: string, assetSubClassLte?: string, type?: string, typeAnyOf?: string, typeGt?: string, typeGte?: string, typeLt?: string, typeLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/futures/vX/products-new`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -15997,234 +22074,200 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (timestamp !== undefined) { - localVarQueryParameter['timestamp'] = timestamp; + if (name !== undefined) { + localVarQueryParameter['name'] = name; } - if (timespan !== undefined) { - localVarQueryParameter['timespan'] = timespan; + if (nameAnyOf !== undefined) { + localVarQueryParameter['name.any_of'] = nameAnyOf; } - if (adjusted !== undefined) { - localVarQueryParameter['adjusted'] = adjusted; + if (nameGt !== undefined) { + localVarQueryParameter['name.gt'] = nameGt; } - if (shortWindow !== undefined) { - localVarQueryParameter['short_window'] = shortWindow; + if (nameGte !== undefined) { + localVarQueryParameter['name.gte'] = nameGte; } - if (longWindow !== undefined) { - localVarQueryParameter['long_window'] = longWindow; + if (nameLt !== undefined) { + localVarQueryParameter['name.lt'] = nameLt; } - if (signalWindow !== undefined) { - localVarQueryParameter['signal_window'] = signalWindow; + if (nameLte !== undefined) { + localVarQueryParameter['name.lte'] = nameLte; } - if (seriesType !== undefined) { - localVarQueryParameter['series_type'] = seriesType; + if (productCode !== undefined) { + localVarQueryParameter['product_code'] = productCode; } - if (expandUnderlying !== undefined) { - localVarQueryParameter['expand_underlying'] = expandUnderlying; + if (productCodeAnyOf !== undefined) { + localVarQueryParameter['product_code.any_of'] = productCodeAnyOf; } - if (order !== undefined) { - localVarQueryParameter['order'] = order; + if (productCodeGt !== undefined) { + localVarQueryParameter['product_code.gt'] = productCodeGt; } - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; + if (productCodeGte !== undefined) { + localVarQueryParameter['product_code.gte'] = productCodeGte; } - if (timestampGte !== undefined) { - localVarQueryParameter['timestamp.gte'] = timestampGte; + if (productCodeLt !== undefined) { + localVarQueryParameter['product_code.lt'] = productCodeLt; } - if (timestampGt !== undefined) { - localVarQueryParameter['timestamp.gt'] = timestampGt; + if (productCodeLte !== undefined) { + localVarQueryParameter['product_code.lte'] = productCodeLte; } - if (timestampLte !== undefined) { - localVarQueryParameter['timestamp.lte'] = timestampLte; + if (date !== undefined) { + localVarQueryParameter['date'] = date; } - if (timestampLt !== undefined) { - localVarQueryParameter['timestamp.lt'] = timestampLt; + if (dateGt !== undefined) { + localVarQueryParameter['date.gt'] = dateGt; } + if (dateGte !== undefined) { + localVarQueryParameter['date.gte'] = dateGte; + } - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + if (dateLt !== undefined) { + localVarQueryParameter['date.lt'] = dateLt; + } - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get BBO quotes for a ticker symbol in a given time range. - * @summary Quotes (BBO) - * @param {string} fxTicker The ticker symbol to get quotes for. - * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. - * @param {string} [timestampGte] Range by timestamp. - * @param {string} [timestampGt] Range by timestamp. - * @param {string} [timestampLte] Range by timestamp. - * @param {string} [timestampLt] Range by timestamp. - * @param {GetForexQuotesOrderEnum} [order] Order results based on the `sort` field. - * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. - * @param {GetForexQuotesSortEnum} [sort] Sort field used for ordering. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getForexQuotes: async (fxTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetForexQuotesOrderEnum, limit?: number, sort?: GetForexQuotesSortEnum, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'fxTicker' is not null or undefined - assertParamExists('getForexQuotes', 'fxTicker', fxTicker) - const localVarPath = `/v3/quotes/{fxTicker}` - .replace(`{${"fxTicker"}}`, encodeURIComponent(String(fxTicker))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; + if (dateLte !== undefined) { + localVarQueryParameter['date.lte'] = dateLte; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; + if (sector !== undefined) { + localVarQueryParameter['sector'] = sector; + } - // authentication apiKey required - await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (sectorAnyOf !== undefined) { + localVarQueryParameter['sector.any_of'] = sectorAnyOf; + } - if (timestamp !== undefined) { - localVarQueryParameter['timestamp'] = timestamp; + if (sectorGt !== undefined) { + localVarQueryParameter['sector.gt'] = sectorGt; } - if (timestampGte !== undefined) { - localVarQueryParameter['timestamp.gte'] = timestampGte; + if (sectorGte !== undefined) { + localVarQueryParameter['sector.gte'] = sectorGte; } - if (timestampGt !== undefined) { - localVarQueryParameter['timestamp.gt'] = timestampGt; + if (sectorLt !== undefined) { + localVarQueryParameter['sector.lt'] = sectorLt; } - if (timestampLte !== undefined) { - localVarQueryParameter['timestamp.lte'] = timestampLte; + if (sectorLte !== undefined) { + localVarQueryParameter['sector.lte'] = sectorLte; } - if (timestampLt !== undefined) { - localVarQueryParameter['timestamp.lt'] = timestampLt; + if (subSector !== undefined) { + localVarQueryParameter['sub_sector'] = subSector; } - if (order !== undefined) { - localVarQueryParameter['order'] = order; + if (subSectorAnyOf !== undefined) { + localVarQueryParameter['sub_sector.any_of'] = subSectorAnyOf; } - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; + if (subSectorGt !== undefined) { + localVarQueryParameter['sub_sector.gt'] = subSectorGt; } - if (sort !== undefined) { - localVarQueryParameter['sort'] = sort; + if (subSectorGte !== undefined) { + localVarQueryParameter['sub_sector.gte'] = subSectorGte; } + if (subSectorLt !== undefined) { + localVarQueryParameter['sub_sector.lt'] = subSectorLt; + } - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + if (subSectorLte !== undefined) { + localVarQueryParameter['sub_sector.lte'] = subSectorLte; + } - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get the relative strength index (RSI) for a ticker symbol over a given time range. - * @summary Relative Strength Index (RSI) - * @param {string} fxTicker The ticker symbol for which to get relative strength index (RSI) data. - * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. - * @param {GetForexRSITimespanEnum} [timespan] The size of the aggregate time window. - * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. - * @param {number} [window] The window size used to calculate the relative strength index (RSI). - * @param {GetForexRSISeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close prices to calculate the relative strength index (RSI). - * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. - * @param {GetForexRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. - * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 - * @param {string} [timestampGte] Range by timestamp. - * @param {string} [timestampGt] Range by timestamp. - * @param {string} [timestampLte] Range by timestamp. - * @param {string} [timestampLt] Range by timestamp. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getForexRSI: async (fxTicker: string, timestamp?: string, timespan?: GetForexRSITimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetForexRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetForexRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'fxTicker' is not null or undefined - assertParamExists('getForexRSI', 'fxTicker', fxTicker) - const localVarPath = `/v1/indicators/rsi/{fxTicker}` - .replace(`{${"fxTicker"}}`, encodeURIComponent(String(fxTicker))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; + if (assetClass !== undefined) { + localVarQueryParameter['asset_class'] = assetClass; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; + if (assetClassAnyOf !== undefined) { + localVarQueryParameter['asset_class.any_of'] = assetClassAnyOf; + } - // authentication apiKey required - await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (assetClassGt !== undefined) { + localVarQueryParameter['asset_class.gt'] = assetClassGt; + } - if (timestamp !== undefined) { - localVarQueryParameter['timestamp'] = timestamp; + if (assetClassGte !== undefined) { + localVarQueryParameter['asset_class.gte'] = assetClassGte; } - if (timespan !== undefined) { - localVarQueryParameter['timespan'] = timespan; + if (assetClassLt !== undefined) { + localVarQueryParameter['asset_class.lt'] = assetClassLt; } - if (adjusted !== undefined) { - localVarQueryParameter['adjusted'] = adjusted; + if (assetClassLte !== undefined) { + localVarQueryParameter['asset_class.lte'] = assetClassLte; } - if (window !== undefined) { - localVarQueryParameter['window'] = window; + if (assetSubClass !== undefined) { + localVarQueryParameter['asset_sub_class'] = assetSubClass; } - if (seriesType !== undefined) { - localVarQueryParameter['series_type'] = seriesType; + if (assetSubClassAnyOf !== undefined) { + localVarQueryParameter['asset_sub_class.any_of'] = assetSubClassAnyOf; } - if (expandUnderlying !== undefined) { - localVarQueryParameter['expand_underlying'] = expandUnderlying; + if (assetSubClassGt !== undefined) { + localVarQueryParameter['asset_sub_class.gt'] = assetSubClassGt; } - if (order !== undefined) { - localVarQueryParameter['order'] = order; + if (assetSubClassGte !== undefined) { + localVarQueryParameter['asset_sub_class.gte'] = assetSubClassGte; + } + + if (assetSubClassLt !== undefined) { + localVarQueryParameter['asset_sub_class.lt'] = assetSubClassLt; + } + + if (assetSubClassLte !== undefined) { + localVarQueryParameter['asset_sub_class.lte'] = assetSubClassLte; + } + + if (type !== undefined) { + localVarQueryParameter['type'] = type; + } + + if (typeAnyOf !== undefined) { + localVarQueryParameter['type.any_of'] = typeAnyOf; + } + + if (typeGt !== undefined) { + localVarQueryParameter['type.gt'] = typeGt; } - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; + if (typeGte !== undefined) { + localVarQueryParameter['type.gte'] = typeGte; } - if (timestampGte !== undefined) { - localVarQueryParameter['timestamp.gte'] = timestampGte; + if (typeLt !== undefined) { + localVarQueryParameter['type.lt'] = typeLt; } - if (timestampGt !== undefined) { - localVarQueryParameter['timestamp.gt'] = timestampGt; + if (typeLte !== undefined) { + localVarQueryParameter['type.lte'] = typeLte; } - if (timestampLte !== undefined) { - localVarQueryParameter['timestamp.lte'] = timestampLte; + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; } - if (timestampLt !== undefined) { - localVarQueryParameter['timestamp.lt'] = timestampLt; + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; } @@ -16239,29 +22282,27 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the simple moving average (SMA) for a ticker symbol over a given time range. - * @summary Simple Moving Average (SMA) - * @param {string} fxTicker The ticker symbol for which to get simple moving average (SMA) data. - * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. - * @param {GetForexSMATimespanEnum} [timespan] The size of the aggregate time window. - * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. - * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. - * @param {GetForexSMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close prices to calculate the simple moving average (SMA). - * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. - * @param {GetForexSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. - * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 - * @param {string} [timestampGte] Range by timestamp. - * @param {string} [timestampGt] Range by timestamp. - * @param {string} [timestampLte] Range by timestamp. - * @param {string} [timestampLt] Range by timestamp. + * Retrieve a snapshot of the most recent futures contract data. + * @summary futures_snapshot_v1 API + * @param {string} [productCode] The code for the contracts\' underlying product. + * @param {string} [productCodeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [productCodeGt] Filter greater than the value. + * @param {string} [productCodeGte] Filter greater than or equal to the value. + * @param {string} [productCodeLt] Filter less than the value. + * @param {string} [productCodeLte] Filter less than or equal to the value. + * @param {string} [ticker] The futures contract identifier, including the base symbol and contract expiration (e.g., ESZ24 for the December 2024 S&P 500 E-mini contract). + * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickerGt] Filter greater than the value. + * @param {string} [tickerGte] Filter greater than or equal to the value. + * @param {string} [tickerLt] Filter less than the value. + * @param {string} [tickerLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'ticker\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getForexSMA: async (fxTicker: string, timestamp?: string, timespan?: GetForexSMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetForexSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetForexSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'fxTicker' is not null or undefined - assertParamExists('getForexSMA', 'fxTicker', fxTicker) - const localVarPath = `/v1/indicators/sma/{fxTicker}` - .replace(`{${"fxTicker"}}`, encodeURIComponent(String(fxTicker))); + getFuturesVXSnapshot: async (productCode?: string, productCodeAnyOf?: string, productCodeGt?: string, productCodeGte?: string, productCodeLt?: string, productCodeLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/futures/vX/snapshot`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -16276,128 +22317,62 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (timestamp !== undefined) { - localVarQueryParameter['timestamp'] = timestamp; + if (productCode !== undefined) { + localVarQueryParameter['product_code'] = productCode; } - if (timespan !== undefined) { - localVarQueryParameter['timespan'] = timespan; + if (productCodeAnyOf !== undefined) { + localVarQueryParameter['product_code.any_of'] = productCodeAnyOf; } - if (adjusted !== undefined) { - localVarQueryParameter['adjusted'] = adjusted; + if (productCodeGt !== undefined) { + localVarQueryParameter['product_code.gt'] = productCodeGt; } - if (window !== undefined) { - localVarQueryParameter['window'] = window; + if (productCodeGte !== undefined) { + localVarQueryParameter['product_code.gte'] = productCodeGte; } - if (seriesType !== undefined) { - localVarQueryParameter['series_type'] = seriesType; + if (productCodeLt !== undefined) { + localVarQueryParameter['product_code.lt'] = productCodeLt; } - if (expandUnderlying !== undefined) { - localVarQueryParameter['expand_underlying'] = expandUnderlying; + if (productCodeLte !== undefined) { + localVarQueryParameter['product_code.lte'] = productCodeLte; } - if (order !== undefined) { - localVarQueryParameter['order'] = order; + if (ticker !== undefined) { + localVarQueryParameter['ticker'] = ticker; } - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; + if (tickerAnyOf !== undefined) { + localVarQueryParameter['ticker.any_of'] = tickerAnyOf; } - if (timestampGte !== undefined) { - localVarQueryParameter['timestamp.gte'] = timestampGte; + if (tickerGt !== undefined) { + localVarQueryParameter['ticker.gt'] = tickerGt; } - if (timestampGt !== undefined) { - localVarQueryParameter['timestamp.gt'] = timestampGt; + if (tickerGte !== undefined) { + localVarQueryParameter['ticker.gte'] = tickerGte; } - if (timestampLte !== undefined) { - localVarQueryParameter['timestamp.lte'] = timestampLte; + if (tickerLt !== undefined) { + localVarQueryParameter['ticker.lt'] = tickerLt; } - if (timestampLt !== undefined) { - localVarQueryParameter['timestamp.lt'] = timestampLt; + if (tickerLte !== undefined) { + localVarQueryParameter['ticker.lte'] = tickerLte; } - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get the current top 20 gainers or losers of the day in forex markets.

Top gainers are those tickers whose price has increased by the highest percentage since the previous day\'s close. Top losers are those tickers whose price has decreased by the highest percentage since the previous day\'s close.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. - * @summary Gainers/Losers - * @param {GetForexSnapshotDirectionDirectionEnum} direction The direction of the snapshot results to return. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getForexSnapshotDirection: async (direction: GetForexSnapshotDirectionDirectionEnum, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'direction' is not null or undefined - assertParamExists('getForexSnapshotDirection', 'direction', direction) - const localVarPath = `/v2/snapshot/locale/global/markets/forex/{direction}` - .replace(`{${"direction"}}`, encodeURIComponent(String(direction))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication apiKey required - await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for a single traded currency symbol.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. - * @summary Ticker - * @param {string} ticker The forex ticker. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getForexSnapshotTicker: async (ticker: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'ticker' is not null or undefined - assertParamExists('getForexSnapshotTicker', 'ticker', ticker) - const localVarPath = `/v2/snapshot/locale/global/markets/forex/tickers/{ticker}` - .replace(`{${"ticker"}}`, encodeURIComponent(String(ticker))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication apiKey required - await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -16410,14 +22385,18 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for all traded forex symbols.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST. - * @summary All Tickers - * @param {Array} [tickers] A case-sensitive comma separated list of tickers to get snapshots for. For example, C:EURUSD, C:GBPCAD, and C:AUDINR. Empty string defaults to querying all tickers. + * Get the daily open, high, low, and close (OHLC) for the entire cryptocurrency markets. + * @summary Grouped Daily (Bars) + * @param {string} date The beginning date for the aggregate window. + * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getForexSnapshotTickers: async (tickers?: Array, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/v2/snapshot/locale/global/markets/forex/tickers`; + getGroupedCryptoAggregates: async (date: string, adjusted?: boolean, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'date' is not null or undefined + assertParamExists('getGroupedCryptoAggregates', 'date', date) + const localVarPath = `/v2/aggs/grouped/locale/global/market/crypto/{date}` + .replace(`{${"date"}}`, encodeURIComponent(String(date))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -16432,8 +22411,8 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (tickers) { - localVarQueryParameter['tickers'] = tickers; + if (adjusted !== undefined) { + localVarQueryParameter['adjusted'] = adjusted; } @@ -16448,25 +22427,18 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get aggregates for a contract in a given time range. - * @summary Aggregates - * @param {string} ticker The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract). - * @param {string} [resolution] This sets the size of the aggregate windows. It accepts custom values that specify the granularity and the duration of the window. For example: 15mins, 30secs, 12hours, or 7days. There are maximum allowable candle sizes. For example, you can request \"1min\" to \"59mins\", but after that you will need to use \"1hr\". If you make a request for a candle size that is not supported, we will return a 400 \"Bad Request - resolution value is not allowed.\" - * @param {string} [windowStart] This sets the range of time for your results. The window_start timestamp you choose specifies the starting edge of the candle or candles you want returned. If no value is set, you will get the oldest or newest available candles, depending on your sort order. You can combine window_start to form a time range, for example: window_start.gte=2024-01-01&window_start.lte=2024-01-31 - * @param {number} [limit] The number of results to return per page (default=1000, maximum=50000, minimum=1). - * @param {string} [windowStartGte] Range by window_start. - * @param {string} [windowStartGt] Range by window_start. - * @param {string} [windowStartLte] Range by window_start. - * @param {string} [windowStartLt] Range by window_start. - * @param {GetFuturesAggregatesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). + * Get the daily open, high, low, and close (OHLC) for the entire forex markets. + * @summary Grouped Daily (Bars) + * @param {string} date The beginning date for the aggregate window. + * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFuturesAggregates: async (ticker: string, resolution?: string, windowStart?: string, limit?: number, windowStartGte?: string, windowStartGt?: string, windowStartLte?: string, windowStartLt?: string, sort?: GetFuturesAggregatesSortEnum, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'ticker' is not null or undefined - assertParamExists('getFuturesAggregates', 'ticker', ticker) - const localVarPath = `/futures/vX/aggs/{ticker}` - .replace(`{${"ticker"}}`, encodeURIComponent(String(ticker))); + getGroupedForexAggregates: async (date: string, adjusted?: boolean, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'date' is not null or undefined + assertParamExists('getGroupedForexAggregates', 'date', date) + const localVarPath = `/v2/aggs/grouped/locale/global/market/fx/{date}` + .replace(`{${"date"}}`, encodeURIComponent(String(date))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -16481,36 +22453,8 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (resolution !== undefined) { - localVarQueryParameter['resolution'] = resolution; - } - - if (windowStart !== undefined) { - localVarQueryParameter['window_start'] = windowStart; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (windowStartGte !== undefined) { - localVarQueryParameter['window_start.gte'] = windowStartGte; - } - - if (windowStartGt !== undefined) { - localVarQueryParameter['window_start.gt'] = windowStartGt; - } - - if (windowStartLte !== undefined) { - localVarQueryParameter['window_start.lte'] = windowStartLte; - } - - if (windowStartLt !== undefined) { - localVarQueryParameter['window_start.lt'] = windowStartLt; - } - - if (sort !== undefined) { - localVarQueryParameter['sort'] = sort; + if (adjusted !== undefined) { + localVarQueryParameter['adjusted'] = adjusted; } @@ -16525,18 +22469,19 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * The Contract Details endpoint returns the details for a single contract at a specific point in time. - * @summary Contract Details - * @param {string} ticker The ticker symbol of the contract to retrieve. - * @param {string} [asOf] The point-in-time of the data to be retrieved. Note that the contract data returned for a given date represents the state of that contract on that day. A date in the format YYYY-MM-DD (default=today). + * Get the daily open, high, low, and close (OHLC) for the entire stocks/equities markets. + * @summary Grouped Daily (Bars) + * @param {string} date The beginning date for the aggregate window. + * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. + * @param {boolean} [includeOtc] Include OTC securities in the response. Default is false (don\'t include OTC securities). * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFuturesContractDetails: async (ticker: string, asOf?: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'ticker' is not null or undefined - assertParamExists('getFuturesContractDetails', 'ticker', ticker) - const localVarPath = `/futures/vX/contracts/{ticker}` - .replace(`{${"ticker"}}`, encodeURIComponent(String(ticker))); + getGroupedStocksAggregates: async (date: string, adjusted?: boolean, includeOtc?: boolean, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'date' is not null or undefined + assertParamExists('getGroupedStocksAggregates', 'date', date) + const localVarPath = `/v2/aggs/grouped/locale/us/market/stocks/{date}` + .replace(`{${"date"}}`, encodeURIComponent(String(date))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -16551,10 +22496,12 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (asOf !== undefined) { - localVarQueryParameter['as_of'] = (asOf as any instanceof Date) ? - (asOf as any).toISOString().substring(0,10) : - asOf; + if (adjusted !== undefined) { + localVarQueryParameter['adjusted'] = adjusted; + } + + if (includeOtc !== undefined) { + localVarQueryParameter['include_otc'] = includeOtc; } @@ -16569,21 +22516,35 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * The Contracts endpoint returns a list of futures contracts. This endpoint can be used to query for contracts based on a variety of parameters, including the contract\'s ticker, product code, first trade date, last trade date, and whether or not the contract was active on a given date. - * @summary Contracts - * @param {string} [productCode] A unique identifier for the Product a Contract belongs to. Note that multiple contracts can belong to the same product. - * @param {string} [firstTradeDate] The first day that a contract was tradeable. A date with the format YYYY-MM-DD. - * @param {string} [lastTradeDate] The last day that the contract was tradeable. A date with the format YYYY-MM-DD. - * @param {string} [asOf] Specify the point-in-time for which you want to retrieve information. Note that the contract data returned for a given date is the state of that contract as of that day. A date in the format YYYY-MM-DD (default=today). - * @param {GetFuturesContractsActiveEnum} [active] Filter for contracts based on whether or not they were tradeable at the given point in time. For example, if the date queried is greater-than or equal-to a contract\'s \'first_trade_date\' and less-than-or-equal-to its \'last_trade_date\', then the contract was active. If the date queried is greater-than-or-equal-to the contract\'s \'last_trade_date\' or less-than-or-equal-to its \'first_trade_date\', then the contract was inactive. - * @param {GetFuturesContractsTypeEnum} [type] The type of contract, one of \"all\", \"single\", or \"combo\" (default=all). - * @param {number} [limit] The number of results to return per page (default=100, max=1000, min=1). - * @param {GetFuturesContractsSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). + * Get aggregate bars for an index over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. + * @summary Aggregates (Bars) + * @param {string} indicesTicker The ticker symbol of Index. + * @param {number} multiplier The size of the timespan multiplier. + * @param {GetIndicesAggregatesTimespanEnum} timespan The size of the time window. + * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. + * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. + * @param {GetIndicesAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). + * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://massive.com/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFuturesContracts: async (productCode?: string, firstTradeDate?: string, lastTradeDate?: string, asOf?: string, active?: GetFuturesContractsActiveEnum, type?: GetFuturesContractsTypeEnum, limit?: number, sort?: GetFuturesContractsSortEnum, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/futures/vX/contracts`; + getIndicesAggregates: async (indicesTicker: string, multiplier: number, timespan: GetIndicesAggregatesTimespanEnum, from: string, to: string, sort?: GetIndicesAggregatesSortEnum, limit?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'indicesTicker' is not null or undefined + assertParamExists('getIndicesAggregates', 'indicesTicker', indicesTicker) + // verify required parameter 'multiplier' is not null or undefined + assertParamExists('getIndicesAggregates', 'multiplier', multiplier) + // verify required parameter 'timespan' is not null or undefined + assertParamExists('getIndicesAggregates', 'timespan', timespan) + // verify required parameter 'from' is not null or undefined + assertParamExists('getIndicesAggregates', 'from', from) + // verify required parameter 'to' is not null or undefined + assertParamExists('getIndicesAggregates', 'to', to) + const localVarPath = `/v2/aggs/ticker/{indicesTicker}/range/{multiplier}/{timespan}/{from}/{to}` + .replace(`{${"indicesTicker"}}`, encodeURIComponent(String(indicesTicker))) + .replace(`{${"multiplier"}}`, encodeURIComponent(String(multiplier))) + .replace(`{${"timespan"}}`, encodeURIComponent(String(timespan))) + .replace(`{${"from"}}`, encodeURIComponent(String(from))) + .replace(`{${"to"}}`, encodeURIComponent(String(to))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -16598,44 +22559,14 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (productCode !== undefined) { - localVarQueryParameter['product_code'] = productCode; - } - - if (firstTradeDate !== undefined) { - localVarQueryParameter['first_trade_date'] = (firstTradeDate as any instanceof Date) ? - (firstTradeDate as any).toISOString().substring(0,10) : - firstTradeDate; - } - - if (lastTradeDate !== undefined) { - localVarQueryParameter['last_trade_date'] = (lastTradeDate as any instanceof Date) ? - (lastTradeDate as any).toISOString().substring(0,10) : - lastTradeDate; - } - - if (asOf !== undefined) { - localVarQueryParameter['as_of'] = (asOf as any instanceof Date) ? - (asOf as any).toISOString().substring(0,10) : - asOf; - } - - if (active !== undefined) { - localVarQueryParameter['active'] = active; - } - - if (type !== undefined) { - localVarQueryParameter['type'] = type; + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } - if (sort !== undefined) { - localVarQueryParameter['sort'] = sort; - } - setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -16648,17 +22579,29 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * The Trading-Date Based Futures Schedules API provides detailed trading schedules for all products on a specific day. This API allows you to retrieve detailed information about trading sessions, including market events like preopen, open, and closed, along with their precise timestamps. - * @summary Daily Schedules - * @param {string} [sessionEndDate] The session end date for the schedules (also known as the trading date). This is the day in CT for which the user wants to retrieve data. If left blank, this value defaults to \'today\' in Central Time. e.g. If a request is made from Pacific Time on \'2025-01-01\' at 11:00 pm with no \'session_end_date\' a default value of `2025-01-02` will be used. - * @param {string} [tradingVenue] The trading venue (MIC) of the exchange for the schedules. - * @param {number} [limit] The number of results to return per page (default=100, max=1000, min=1). - * @param {GetFuturesDailySchedulesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). + * Get the exponential moving average (EMA) for a ticker symbol over a given time range. + * @summary Exponential Moving Average (EMA) + * @param {string} indicesTicker The ticker symbol for which to get exponential moving average (EMA) data. + * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. + * @param {GetIndicesEMATimespanEnum} [timespan] The size of the aggregate time window. + * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. + * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. + * @param {GetIndicesEMASeriesTypeEnum} [seriesType] The value in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close values to calculate the exponential moving average (EMA). + * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. + * @param {GetIndicesEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. + * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 + * @param {string} [timestampGte] Range by timestamp. + * @param {string} [timestampGt] Range by timestamp. + * @param {string} [timestampLte] Range by timestamp. + * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFuturesDailySchedules: async (sessionEndDate?: string, tradingVenue?: string, limit?: number, sort?: GetFuturesDailySchedulesSortEnum, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/futures/vX/schedules`; + getIndicesEMA: async (indicesTicker: string, timestamp?: string, timespan?: GetIndicesEMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetIndicesEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetIndicesEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'indicesTicker' is not null or undefined + assertParamExists('getIndicesEMA', 'indicesTicker', indicesTicker) + const localVarPath = `/v1/indicators/ema/{indicesTicker}` + .replace(`{${"indicesTicker"}}`, encodeURIComponent(String(indicesTicker))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -16673,22 +22616,52 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (sessionEndDate !== undefined) { - localVarQueryParameter['session_end_date'] = (sessionEndDate as any instanceof Date) ? - (sessionEndDate as any).toISOString().substring(0,10) : - sessionEndDate; + if (timestamp !== undefined) { + localVarQueryParameter['timestamp'] = timestamp; } - if (tradingVenue !== undefined) { - localVarQueryParameter['trading_venue'] = tradingVenue; + if (timespan !== undefined) { + localVarQueryParameter['timespan'] = timespan; + } + + if (adjusted !== undefined) { + localVarQueryParameter['adjusted'] = adjusted; + } + + if (window !== undefined) { + localVarQueryParameter['window'] = window; + } + + if (seriesType !== undefined) { + localVarQueryParameter['series_type'] = seriesType; + } + + if (expandUnderlying !== undefined) { + localVarQueryParameter['expand_underlying'] = expandUnderlying; + } + + if (order !== undefined) { + localVarQueryParameter['order'] = order; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } - if (sort !== undefined) { - localVarQueryParameter['sort'] = sort; + if (timestampGte !== undefined) { + localVarQueryParameter['timestamp.gte'] = timestampGte; + } + + if (timestampGt !== undefined) { + localVarQueryParameter['timestamp.gt'] = timestampGt; + } + + if (timestampLte !== undefined) { + localVarQueryParameter['timestamp.lte'] = timestampLte; + } + + if (timestampLt !== undefined) { + localVarQueryParameter['timestamp.lt'] = timestampLt; } @@ -16703,17 +22676,31 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * The market status endpoint returns the current status of the futures market for the given product code(s). - * @summary Market Status - * @param {string} [productCodeAnyOf] The product code(s) to return market statuses for. Multiple product codes can be specified by separating them with a comma. Currently, the limit is 250 product codes. - * @param {string} [productCode] The product code to return market statuses for. - * @param {number} [limit] The number of results to return per page (default=100, max=1000, min=1). - * @param {GetFuturesMarketStatusesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). + * Get moving average convergence/divergence (MACD) for a ticker symbol over a given time range. + * @summary Moving Average Convergence/Divergence (MACD) + * @param {string} indicesTicker The ticker symbol for which to get MACD data. + * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. + * @param {GetIndicesMACDTimespanEnum} [timespan] The size of the aggregate time window. + * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. + * @param {number} [shortWindow] The short window size used to calculate MACD data. + * @param {number} [longWindow] The long window size used to calculate MACD data. + * @param {number} [signalWindow] The window size used to calculate the MACD signal line. + * @param {GetIndicesMACDSeriesTypeEnum} [seriesType] The value in the aggregate which will be used to calculate the MACD. i.e. \'close\' will result in using close values to calculate the MACD. + * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. + * @param {GetIndicesMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. + * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 + * @param {string} [timestampGte] Range by timestamp. + * @param {string} [timestampGt] Range by timestamp. + * @param {string} [timestampLte] Range by timestamp. + * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFuturesMarketStatuses: async (productCodeAnyOf?: string, productCode?: string, limit?: number, sort?: GetFuturesMarketStatusesSortEnum, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/futures/vX/market-status`; + getIndicesMACD: async (indicesTicker: string, timestamp?: string, timespan?: GetIndicesMACDTimespanEnum, adjusted?: boolean, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetIndicesMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetIndicesMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'indicesTicker' is not null or undefined + assertParamExists('getIndicesMACD', 'indicesTicker', indicesTicker) + const localVarPath = `/v1/indicators/macd/{indicesTicker}` + .replace(`{${"indicesTicker"}}`, encodeURIComponent(String(indicesTicker))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -16728,20 +22715,60 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (productCodeAnyOf !== undefined) { - localVarQueryParameter['product_code.any_of'] = productCodeAnyOf; + if (timestamp !== undefined) { + localVarQueryParameter['timestamp'] = timestamp; } - if (productCode !== undefined) { - localVarQueryParameter['product_code'] = productCode; + if (timespan !== undefined) { + localVarQueryParameter['timespan'] = timespan; + } + + if (adjusted !== undefined) { + localVarQueryParameter['adjusted'] = adjusted; + } + + if (shortWindow !== undefined) { + localVarQueryParameter['short_window'] = shortWindow; + } + + if (longWindow !== undefined) { + localVarQueryParameter['long_window'] = longWindow; + } + + if (signalWindow !== undefined) { + localVarQueryParameter['signal_window'] = signalWindow; + } + + if (seriesType !== undefined) { + localVarQueryParameter['series_type'] = seriesType; + } + + if (expandUnderlying !== undefined) { + localVarQueryParameter['expand_underlying'] = expandUnderlying; + } + + if (order !== undefined) { + localVarQueryParameter['order'] = order; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } - if (sort !== undefined) { - localVarQueryParameter['sort'] = sort; + if (timestampGte !== undefined) { + localVarQueryParameter['timestamp.gte'] = timestampGte; + } + + if (timestampGt !== undefined) { + localVarQueryParameter['timestamp.gt'] = timestampGt; + } + + if (timestampLte !== undefined) { + localVarQueryParameter['timestamp.lte'] = timestampLte; + } + + if (timestampLt !== undefined) { + localVarQueryParameter['timestamp.lt'] = timestampLt; } @@ -16756,19 +22783,21 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * The Product Details endpoint returns the details for a single product as of a specific day. - * @summary Product Details - * @param {string} productCode The unique identifier for a product. - * @param {GetFuturesProductDetailsTypeEnum} [type] The type of product to return. One of \"single\" or \"combo\" (default=single). - * @param {string} [asOf] A date string in the format YYYY-MM-DD. Note that the data returned is the state of this product\'s data at that point-in-time. + * Get the open, close and afterhours values of a index symbol on a certain date. + * @summary Daily Open/Close + * @param {string} indicesTicker The ticker symbol of Index. + * @param {string} date The date of the requested open/close in the format YYYY-MM-DD. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFuturesProductDetails: async (productCode: string, type?: GetFuturesProductDetailsTypeEnum, asOf?: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'productCode' is not null or undefined - assertParamExists('getFuturesProductDetails', 'productCode', productCode) - const localVarPath = `/futures/vX/products/{product_code}` - .replace(`{${"product_code"}}`, encodeURIComponent(String(productCode))); + getIndicesOpenClose: async (indicesTicker: string, date: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'indicesTicker' is not null or undefined + assertParamExists('getIndicesOpenClose', 'indicesTicker', indicesTicker) + // verify required parameter 'date' is not null or undefined + assertParamExists('getIndicesOpenClose', 'date', date) + const localVarPath = `/v1/open-close/{indicesTicker}/{date}` + .replace(`{${"indicesTicker"}}`, encodeURIComponent(String(indicesTicker))) + .replace(`{${"date"}}`, encodeURIComponent(String(date))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -16783,16 +22812,6 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (type !== undefined) { - localVarQueryParameter['type'] = type; - } - - if (asOf !== undefined) { - localVarQueryParameter['as_of'] = (asOf as any instanceof Date) ? - (asOf as any).toISOString().substring(0,10) : - asOf; - } - setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -16805,24 +22824,29 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * The Product-Specific Futures Schedules API provides detailed trading schedules for a specific futures product. This API allows you to query schedules for a single product across a range of dates. Users can access comprehensive information about trading sessions, including market events such as preopen, open, and closed, along with their precise timestamps. - * @summary Product Schedules - * @param {string} productCode The product code for the futures product. - * @param {string} [sessionEndDate] The date on which the schedule\'s trading day ended (sometimes referred to as trading date). Defaults to today. Formatted as `YYYY-MM-DD`. Note that although there is no time component the day is assumed to be that day in Central Time. - * @param {number} [limit] The number of results to return per page (default=100, max=1000, min=1). - * @param {string} [sessionEndDateGte] Range by session_end_date. - * @param {string} [sessionEndDateGt] Range by session_end_date. - * @param {string} [sessionEndDateLte] Range by session_end_date. - * @param {string} [sessionEndDateLt] Range by session_end_date. - * @param {GetFuturesProductSchedulesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). + * Get the relative strength index (RSI) for a ticker symbol over a given time range. + * @summary Relative Strength Index (RSI) + * @param {string} indicesTicker The ticker symbol for which to get relative strength index (RSI) data. + * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. + * @param {GetIndicesRSITimespanEnum} [timespan] The size of the aggregate time window. + * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. + * @param {number} [window] The window size used to calculate the relative strength index (RSI). + * @param {GetIndicesRSISeriesTypeEnum} [seriesType] The value in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close values to calculate the relative strength index (RSI). + * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. + * @param {GetIndicesRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. + * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 + * @param {string} [timestampGte] Range by timestamp. + * @param {string} [timestampGt] Range by timestamp. + * @param {string} [timestampLte] Range by timestamp. + * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFuturesProductSchedules: async (productCode: string, sessionEndDate?: string, limit?: number, sessionEndDateGte?: string, sessionEndDateGt?: string, sessionEndDateLte?: string, sessionEndDateLt?: string, sort?: GetFuturesProductSchedulesSortEnum, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'productCode' is not null or undefined - assertParamExists('getFuturesProductSchedules', 'productCode', productCode) - const localVarPath = `/futures/vX/products/{product_code}/schedules` - .replace(`{${"product_code"}}`, encodeURIComponent(String(productCode))); + getIndicesRSI: async (indicesTicker: string, timestamp?: string, timespan?: GetIndicesRSITimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetIndicesRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetIndicesRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'indicesTicker' is not null or undefined + assertParamExists('getIndicesRSI', 'indicesTicker', indicesTicker) + const localVarPath = `/v1/indicators/rsi/{indicesTicker}` + .replace(`{${"indicesTicker"}}`, encodeURIComponent(String(indicesTicker))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -16837,42 +22861,52 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (sessionEndDate !== undefined) { - localVarQueryParameter['session_end_date'] = (sessionEndDate as any instanceof Date) ? - (sessionEndDate as any).toISOString().substring(0,10) : - sessionEndDate; + if (timestamp !== undefined) { + localVarQueryParameter['timestamp'] = timestamp; } - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; + if (timespan !== undefined) { + localVarQueryParameter['timespan'] = timespan; } - if (sessionEndDateGte !== undefined) { - localVarQueryParameter['session_end_date.gte'] = (sessionEndDateGte as any instanceof Date) ? - (sessionEndDateGte as any).toISOString().substring(0,10) : - sessionEndDateGte; + if (adjusted !== undefined) { + localVarQueryParameter['adjusted'] = adjusted; } - if (sessionEndDateGt !== undefined) { - localVarQueryParameter['session_end_date.gt'] = (sessionEndDateGt as any instanceof Date) ? - (sessionEndDateGt as any).toISOString().substring(0,10) : - sessionEndDateGt; + if (window !== undefined) { + localVarQueryParameter['window'] = window; } - if (sessionEndDateLte !== undefined) { - localVarQueryParameter['session_end_date.lte'] = (sessionEndDateLte as any instanceof Date) ? - (sessionEndDateLte as any).toISOString().substring(0,10) : - sessionEndDateLte; + if (seriesType !== undefined) { + localVarQueryParameter['series_type'] = seriesType; } - if (sessionEndDateLt !== undefined) { - localVarQueryParameter['session_end_date.lt'] = (sessionEndDateLt as any instanceof Date) ? - (sessionEndDateLt as any).toISOString().substring(0,10) : - sessionEndDateLt; + if (expandUnderlying !== undefined) { + localVarQueryParameter['expand_underlying'] = expandUnderlying; } - if (sort !== undefined) { - localVarQueryParameter['sort'] = sort; + if (order !== undefined) { + localVarQueryParameter['order'] = order; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (timestampGte !== undefined) { + localVarQueryParameter['timestamp.gte'] = timestampGte; + } + + if (timestampGt !== undefined) { + localVarQueryParameter['timestamp.gt'] = timestampGt; + } + + if (timestampLte !== undefined) { + localVarQueryParameter['timestamp.lte'] = timestampLte; + } + + if (timestampLt !== undefined) { + localVarQueryParameter['timestamp.lt'] = timestampLt; } @@ -16887,24 +22921,29 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * The Products endpoint returns a list of futures products. This endpoint can be used to query for products based on a variety of parameters, including by the product\'s name, exchange, sector, sub-sector, asset class, asset sub-class, and type. - * @summary Products - * @param {string} [name] Search for products by Product Name. This parameter supports an exact match, while a name-contains search can be performed using the `name.search` parameter. Note that the search is case-sensitive. - * @param {string} [asOf] A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about products for the specified day (default=today). - * @param {string} [tradingVenue] The trading venue (MIC) for the exchange on which the products trades. - * @param {GetFuturesProductsSectorEnum} [sector] The sector to which the products belong. - * @param {GetFuturesProductsSubSectorEnum} [subSector] The sub-sector to which the products belong. - * @param {GetFuturesProductsAssetClassEnum} [assetClass] The asset class to which the products belong. - * @param {GetFuturesProductsAssetSubClassEnum} [assetSubClass] The asset sub-class to which the products belong. - * @param {GetFuturesProductsTypeEnum} [type] The type of products to return. One of \"all\", \"single\", or \"combo\" (default=all). - * @param {number} [limit] The number of results to return per page (default=100, maximum=1000, minimum=1). - * @param {string} [nameSearch] Search by name. - * @param {GetFuturesProductsSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). + * Get the simple moving average (SMA) for a ticker symbol over a given time range. + * @summary Simple Moving Average (SMA) + * @param {string} indicesTicker The ticker symbol for which to get simple moving average (SMA) data. + * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. + * @param {GetIndicesSMATimespanEnum} [timespan] The size of the aggregate time window. + * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. + * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. + * @param {GetIndicesSMASeriesTypeEnum} [seriesType] The value in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close values to calculate the simple moving average (SMA). + * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. + * @param {GetIndicesSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. + * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 + * @param {string} [timestampGte] Range by timestamp. + * @param {string} [timestampGt] Range by timestamp. + * @param {string} [timestampLte] Range by timestamp. + * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFuturesProducts: async (name?: string, asOf?: string, tradingVenue?: string, sector?: GetFuturesProductsSectorEnum, subSector?: GetFuturesProductsSubSectorEnum, assetClass?: GetFuturesProductsAssetClassEnum, assetSubClass?: GetFuturesProductsAssetSubClassEnum, type?: GetFuturesProductsTypeEnum, limit?: number, nameSearch?: string, sort?: GetFuturesProductsSortEnum, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/futures/vX/products`; + getIndicesSMA: async (indicesTicker: string, timestamp?: string, timespan?: GetIndicesSMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetIndicesSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetIndicesSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'indicesTicker' is not null or undefined + assertParamExists('getIndicesSMA', 'indicesTicker', indicesTicker) + const localVarPath = `/v1/indicators/sma/{indicesTicker}` + .replace(`{${"indicesTicker"}}`, encodeURIComponent(String(indicesTicker))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -16919,50 +22958,52 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (name !== undefined) { - localVarQueryParameter['name'] = name; - } - - if (asOf !== undefined) { - localVarQueryParameter['as_of'] = (asOf as any instanceof Date) ? - (asOf as any).toISOString().substring(0,10) : - asOf; + if (timestamp !== undefined) { + localVarQueryParameter['timestamp'] = timestamp; } - if (tradingVenue !== undefined) { - localVarQueryParameter['trading_venue'] = tradingVenue; + if (timespan !== undefined) { + localVarQueryParameter['timespan'] = timespan; } - if (sector !== undefined) { - localVarQueryParameter['sector'] = sector; + if (adjusted !== undefined) { + localVarQueryParameter['adjusted'] = adjusted; } - if (subSector !== undefined) { - localVarQueryParameter['sub_sector'] = subSector; + if (window !== undefined) { + localVarQueryParameter['window'] = window; } - if (assetClass !== undefined) { - localVarQueryParameter['asset_class'] = assetClass; + if (seriesType !== undefined) { + localVarQueryParameter['series_type'] = seriesType; } - if (assetSubClass !== undefined) { - localVarQueryParameter['asset_sub_class'] = assetSubClass; + if (expandUnderlying !== undefined) { + localVarQueryParameter['expand_underlying'] = expandUnderlying; } - if (type !== undefined) { - localVarQueryParameter['type'] = type; + if (order !== undefined) { + localVarQueryParameter['order'] = order; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } - if (nameSearch !== undefined) { - localVarQueryParameter['name.search'] = nameSearch; + if (timestampGte !== undefined) { + localVarQueryParameter['timestamp.gte'] = timestampGte; } - if (sort !== undefined) { - localVarQueryParameter['sort'] = sort; + if (timestampGt !== undefined) { + localVarQueryParameter['timestamp.gt'] = timestampGt; + } + + if (timestampLte !== undefined) { + localVarQueryParameter['timestamp.lte'] = timestampLte; + } + + if (timestampLt !== undefined) { + localVarQueryParameter['timestamp.lt'] = timestampLt; } @@ -16977,29 +23018,22 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get quotes for a contract in a given time range. - * @summary Quotes - * @param {string} ticker The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract). - * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. - * @param {string} [sessionEndDate] Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format. - * @param {number} [limit] The number of results to return per page (default=1000, maximum=50000, minimum=1). - * @param {string} [timestampGte] Range by timestamp. - * @param {string} [timestampGt] Range by timestamp. - * @param {string} [timestampLte] Range by timestamp. - * @param {string} [timestampLt] Range by timestamp. - * @param {string} [sessionEndDateGte] Range by session_end_date. - * @param {string} [sessionEndDateGt] Range by session_end_date. - * @param {string} [sessionEndDateLte] Range by session_end_date. - * @param {string} [sessionEndDateLt] Range by session_end_date. - * @param {GetFuturesQuotesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). + * Get a Snapshot of indices data for said tickers + * @summary Indices Snapshot + * @param {string} [tickerAnyOf] Comma separated list of tickers, up to a maximum of 250. If no tickers are passed then all results will be returned in a paginated manner. Warning: The maximum number of characters allowed in a URL are subject to your technology stack. + * @param {string} [ticker] Search a range of tickers lexicographically. + * @param {string} [tickerGte] Range by ticker. + * @param {string} [tickerGt] Range by ticker. + * @param {string} [tickerLte] Range by ticker. + * @param {string} [tickerLt] Range by ticker. + * @param {GetIndicesSnapshotOrderEnum} [order] Order results based on the `sort` field. + * @param {number} [limit] Limit the number of results returned, default is 10 and max is 250. + * @param {GetIndicesSnapshotSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFuturesQuotes: async (ticker: string, timestamp?: string, sessionEndDate?: string, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, sessionEndDateGte?: string, sessionEndDateGt?: string, sessionEndDateLte?: string, sessionEndDateLt?: string, sort?: GetFuturesQuotesSortEnum, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'ticker' is not null or undefined - assertParamExists('getFuturesQuotes', 'ticker', ticker) - const localVarPath = `/futures/vX/quotes/{ticker}` - .replace(`{${"ticker"}}`, encodeURIComponent(String(ticker))); + getIndicesSnapshot: async (tickerAnyOf?: string, ticker?: string, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, order?: GetIndicesSnapshotOrderEnum, limit?: number, sort?: GetIndicesSnapshotSortEnum, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/v3/snapshot/indices`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -17014,48 +23048,36 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (timestamp !== undefined) { - localVarQueryParameter['timestamp'] = timestamp; - } - - if (sessionEndDate !== undefined) { - localVarQueryParameter['session_end_date'] = sessionEndDate; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (timestampGte !== undefined) { - localVarQueryParameter['timestamp.gte'] = timestampGte; + if (tickerAnyOf !== undefined) { + localVarQueryParameter['ticker.any_of'] = tickerAnyOf; } - if (timestampGt !== undefined) { - localVarQueryParameter['timestamp.gt'] = timestampGt; + if (ticker !== undefined) { + localVarQueryParameter['ticker'] = ticker; } - if (timestampLte !== undefined) { - localVarQueryParameter['timestamp.lte'] = timestampLte; + if (tickerGte !== undefined) { + localVarQueryParameter['ticker.gte'] = tickerGte; } - if (timestampLt !== undefined) { - localVarQueryParameter['timestamp.lt'] = timestampLt; + if (tickerGt !== undefined) { + localVarQueryParameter['ticker.gt'] = tickerGt; } - if (sessionEndDateGte !== undefined) { - localVarQueryParameter['session_end_date.gte'] = sessionEndDateGte; + if (tickerLte !== undefined) { + localVarQueryParameter['ticker.lte'] = tickerLte; } - if (sessionEndDateGt !== undefined) { - localVarQueryParameter['session_end_date.gt'] = sessionEndDateGt; + if (tickerLt !== undefined) { + localVarQueryParameter['ticker.lt'] = tickerLt; } - if (sessionEndDateLte !== undefined) { - localVarQueryParameter['session_end_date.lte'] = sessionEndDateLte; + if (order !== undefined) { + localVarQueryParameter['order'] = order; } - if (sessionEndDateLt !== undefined) { - localVarQueryParameter['session_end_date.lt'] = sessionEndDateLt; + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; } if (sort !== undefined) { @@ -17074,29 +23096,21 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get trades for a contract in a given time range. - * @summary Trades - * @param {string} ticker The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract). - * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. - * @param {string} [sessionEndDate] Also known as the trading date, the date of the end of the trading session, in YYYY-MM-DD format. - * @param {number} [limit] The number of results to return per page (default=1000, maximum=50000, minimum=1). - * @param {string} [timestampGte] Range by timestamp. - * @param {string} [timestampGt] Range by timestamp. - * @param {string} [timestampLte] Range by timestamp. - * @param {string} [timestampLt] Range by timestamp. - * @param {string} [sessionEndDateGte] Range by session_end_date. - * @param {string} [sessionEndDateGt] Range by session_end_date. - * @param {string} [sessionEndDateLte] Range by session_end_date. - * @param {string} [sessionEndDateLt] Range by session_end_date. - * @param {GetFuturesTradesSortEnum} [sort] Sort results by field and direction using dotted notation (e.g., \'ticker.asc\', \'name.desc\'). + * Get the last trade tick for a cryptocurrency pair. + * @summary Last Trade for a Crypto Pair + * @param {string} from The \"from\" symbol of the pair. + * @param {string} to The \"to\" symbol of the pair. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFuturesTrades: async (ticker: string, timestamp?: string, sessionEndDate?: string, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, sessionEndDateGte?: string, sessionEndDateGt?: string, sessionEndDateLte?: string, sessionEndDateLt?: string, sort?: GetFuturesTradesSortEnum, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'ticker' is not null or undefined - assertParamExists('getFuturesTrades', 'ticker', ticker) - const localVarPath = `/futures/vX/trades/{ticker}` - .replace(`{${"ticker"}}`, encodeURIComponent(String(ticker))); + getLastCryptoTrade: async (from: string, to: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'from' is not null or undefined + assertParamExists('getLastCryptoTrade', 'from', from) + // verify required parameter 'to' is not null or undefined + assertParamExists('getLastCryptoTrade', 'to', to) + const localVarPath = `/v1/last/crypto/{from}/{to}` + .replace(`{${"from"}}`, encodeURIComponent(String(from))) + .replace(`{${"to"}}`, encodeURIComponent(String(to))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -17111,53 +23125,83 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (timestamp !== undefined) { - localVarQueryParameter['timestamp'] = timestamp; - } - - if (sessionEndDate !== undefined) { - localVarQueryParameter['session_end_date'] = sessionEndDate; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - if (timestampGte !== undefined) { - localVarQueryParameter['timestamp.gte'] = timestampGte; - } + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - if (timestampGt !== undefined) { - localVarQueryParameter['timestamp.gt'] = timestampGt; + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get the last quote tick for a forex currency pair. + * @summary Last Quote for a Currency Pair + * @param {string} from The \"from\" symbol of the pair. + * @param {string} to The \"to\" symbol of the pair. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getLastCurrencyQuote: async (from: string, to: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'from' is not null or undefined + assertParamExists('getLastCurrencyQuote', 'from', from) + // verify required parameter 'to' is not null or undefined + assertParamExists('getLastCurrencyQuote', 'to', to) + const localVarPath = `/v1/last_quote/currencies/{from}/{to}` + .replace(`{${"from"}}`, encodeURIComponent(String(from))) + .replace(`{${"to"}}`, encodeURIComponent(String(to))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; } - if (timestampLte !== undefined) { - localVarQueryParameter['timestamp.lte'] = timestampLte; - } + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; - if (timestampLt !== undefined) { - localVarQueryParameter['timestamp.lt'] = timestampLt; - } + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (sessionEndDateGte !== undefined) { - localVarQueryParameter['session_end_date.gte'] = sessionEndDateGte; - } - if (sessionEndDateGt !== undefined) { - localVarQueryParameter['session_end_date.gt'] = sessionEndDateGt; - } + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - if (sessionEndDateLte !== undefined) { - localVarQueryParameter['session_end_date.lte'] = sessionEndDateLte; + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get the most recent trade for a given options contract. + * @summary Last Trade + * @param {string} optionsTicker The ticker symbol of the options contract. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getLastOptionsTrade: async (optionsTicker: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'optionsTicker' is not null or undefined + assertParamExists('getLastOptionsTrade', 'optionsTicker', optionsTicker) + const localVarPath = `/v2/last/trade/{optionsTicker}` + .replace(`{${"optionsTicker"}}`, encodeURIComponent(String(optionsTicker))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; } - if (sessionEndDateLt !== undefined) { - localVarQueryParameter['session_end_date.lt'] = sessionEndDateLt; - } + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; - if (sort !== undefined) { - localVarQueryParameter['sort'] = sort; - } + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) @@ -17171,18 +23215,17 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the daily open, high, low, and close (OHLC) for the entire cryptocurrency markets. - * @summary Grouped Daily (Bars) - * @param {string} date The beginning date for the aggregate window. - * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. + * Get the most recent NBBO (Quote) tick for a given stock. + * @summary Last Quote + * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getGroupedCryptoAggregates: async (date: string, adjusted?: boolean, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'date' is not null or undefined - assertParamExists('getGroupedCryptoAggregates', 'date', date) - const localVarPath = `/v2/aggs/grouped/locale/global/market/crypto/{date}` - .replace(`{${"date"}}`, encodeURIComponent(String(date))); + getLastStocksQuote: async (stocksTicker: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'stocksTicker' is not null or undefined + assertParamExists('getLastStocksQuote', 'stocksTicker', stocksTicker) + const localVarPath = `/v2/last/nbbo/{stocksTicker}` + .replace(`{${"stocksTicker"}}`, encodeURIComponent(String(stocksTicker))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -17197,10 +23240,6 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (adjusted !== undefined) { - localVarQueryParameter['adjusted'] = adjusted; - } - setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -17213,18 +23252,17 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the daily open, high, low, and close (OHLC) for the entire forex markets. - * @summary Grouped Daily (Bars) - * @param {string} date The beginning date for the aggregate window. - * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. + * Get the most recent trade for a given stock. + * @summary Last Trade + * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getGroupedForexAggregates: async (date: string, adjusted?: boolean, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'date' is not null or undefined - assertParamExists('getGroupedForexAggregates', 'date', date) - const localVarPath = `/v2/aggs/grouped/locale/global/market/fx/{date}` - .replace(`{${"date"}}`, encodeURIComponent(String(date))); + getLastStocksTrade: async (stocksTicker: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'stocksTicker' is not null or undefined + assertParamExists('getLastStocksTrade', 'stocksTicker', stocksTicker) + const localVarPath = `/v2/last/trade/{stocksTicker}` + .replace(`{${"stocksTicker"}}`, encodeURIComponent(String(stocksTicker))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -17239,10 +23277,6 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (adjusted !== undefined) { - localVarQueryParameter['adjusted'] = adjusted; - } - setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -17255,19 +23289,13 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the daily open, high, low, and close (OHLC) for the entire stocks/equities markets. - * @summary Grouped Daily (Bars) - * @param {string} date The beginning date for the aggregate window. - * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. - * @param {boolean} [includeOtc] Include OTC securities in the response. Default is false (don\'t include OTC securities). + * Get upcoming market holidays and their open/close times. + * @summary Market Holidays * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getGroupedStocksAggregates: async (date: string, adjusted?: boolean, includeOtc?: boolean, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'date' is not null or undefined - assertParamExists('getGroupedStocksAggregates', 'date', date) - const localVarPath = `/v2/aggs/grouped/locale/us/market/stocks/{date}` - .replace(`{${"date"}}`, encodeURIComponent(String(date))); + getMarketHolidays: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/v1/marketstatus/upcoming`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -17282,14 +23310,6 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (adjusted !== undefined) { - localVarQueryParameter['adjusted'] = adjusted; - } - - if (includeOtc !== undefined) { - localVarQueryParameter['include_otc'] = includeOtc; - } - setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -17302,35 +23322,54 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get aggregate bars for an index over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. - * @summary Aggregates (Bars) - * @param {string} indicesTicker The ticker symbol of Index. - * @param {number} multiplier The size of the timespan multiplier. - * @param {GetIndicesAggregatesTimespanEnum} timespan The size of the time window. - * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. - * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. - * @param {GetIndicesAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). - * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. + * Get the current trading status of the exchanges and overall financial markets. + * @summary Market Status * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getIndicesAggregates: async (indicesTicker: string, multiplier: number, timespan: GetIndicesAggregatesTimespanEnum, from: string, to: string, sort?: GetIndicesAggregatesSortEnum, limit?: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'indicesTicker' is not null or undefined - assertParamExists('getIndicesAggregates', 'indicesTicker', indicesTicker) - // verify required parameter 'multiplier' is not null or undefined - assertParamExists('getIndicesAggregates', 'multiplier', multiplier) - // verify required parameter 'timespan' is not null or undefined - assertParamExists('getIndicesAggregates', 'timespan', timespan) - // verify required parameter 'from' is not null or undefined - assertParamExists('getIndicesAggregates', 'from', from) - // verify required parameter 'to' is not null or undefined - assertParamExists('getIndicesAggregates', 'to', to) - const localVarPath = `/v2/aggs/ticker/{indicesTicker}/range/{multiplier}/{timespan}/{from}/{to}` - .replace(`{${"indicesTicker"}}`, encodeURIComponent(String(indicesTicker))) - .replace(`{${"multiplier"}}`, encodeURIComponent(String(multiplier))) - .replace(`{${"timespan"}}`, encodeURIComponent(String(timespan))) - .replace(`{${"from"}}`, encodeURIComponent(String(from))) - .replace(`{${"to"}}`, encodeURIComponent(String(to))); + getMarketStatus: async (options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/v1/marketstatus/now`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get the snapshot of an option contract for a stock equity. + * @summary Option Contract + * @param {string} underlyingAsset The underlying ticker symbol of the option contract. + * @param {string} optionContract The option contract identifier. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getOptionContract: async (underlyingAsset: string, optionContract: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'underlyingAsset' is not null or undefined + assertParamExists('getOptionContract', 'underlyingAsset', underlyingAsset) + // verify required parameter 'optionContract' is not null or undefined + assertParamExists('getOptionContract', 'optionContract', optionContract) + const localVarPath = `/v3/snapshot/options/{underlyingAsset}/{optionContract}` + .replace(`{${"underlyingAsset"}}`, encodeURIComponent(String(underlyingAsset))) + .replace(`{${"optionContract"}}`, encodeURIComponent(String(optionContract))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -17345,14 +23384,6 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (sort !== undefined) { - localVarQueryParameter['sort'] = sort; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -17365,29 +23396,36 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the exponential moving average (EMA) for a ticker symbol over a given time range. - * @summary Exponential Moving Average (EMA) - * @param {string} indicesTicker The ticker symbol for which to get exponential moving average (EMA) data. - * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. - * @param {GetIndicesEMATimespanEnum} [timespan] The size of the aggregate time window. - * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. - * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. - * @param {GetIndicesEMASeriesTypeEnum} [seriesType] The value in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close values to calculate the exponential moving average (EMA). - * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. - * @param {GetIndicesEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. - * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 - * @param {string} [timestampGte] Range by timestamp. - * @param {string} [timestampGt] Range by timestamp. - * @param {string} [timestampLte] Range by timestamp. - * @param {string} [timestampLt] Range by timestamp. + * Get aggregate bars for an option contract over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. + * @summary Aggregates (Bars) + * @param {string} optionsTicker The ticker symbol of the options contract. + * @param {number} multiplier The size of the timespan multiplier. + * @param {GetOptionsAggregatesTimespanEnum} timespan The size of the time window. + * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. + * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. + * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. + * @param {GetOptionsAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). + * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://massive.com/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getIndicesEMA: async (indicesTicker: string, timestamp?: string, timespan?: GetIndicesEMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetIndicesEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetIndicesEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'indicesTicker' is not null or undefined - assertParamExists('getIndicesEMA', 'indicesTicker', indicesTicker) - const localVarPath = `/v1/indicators/ema/{indicesTicker}` - .replace(`{${"indicesTicker"}}`, encodeURIComponent(String(indicesTicker))); + getOptionsAggregates: async (optionsTicker: string, multiplier: number, timespan: GetOptionsAggregatesTimespanEnum, from: string, to: string, adjusted?: boolean, sort?: GetOptionsAggregatesSortEnum, limit?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'optionsTicker' is not null or undefined + assertParamExists('getOptionsAggregates', 'optionsTicker', optionsTicker) + // verify required parameter 'multiplier' is not null or undefined + assertParamExists('getOptionsAggregates', 'multiplier', multiplier) + // verify required parameter 'timespan' is not null or undefined + assertParamExists('getOptionsAggregates', 'timespan', timespan) + // verify required parameter 'from' is not null or undefined + assertParamExists('getOptionsAggregates', 'from', from) + // verify required parameter 'to' is not null or undefined + assertParamExists('getOptionsAggregates', 'to', to) + const localVarPath = `/v2/aggs/ticker/{optionsTicker}/range/{multiplier}/{timespan}/{from}/{to}` + .replace(`{${"optionsTicker"}}`, encodeURIComponent(String(optionsTicker))) + .replace(`{${"multiplier"}}`, encodeURIComponent(String(multiplier))) + .replace(`{${"timespan"}}`, encodeURIComponent(String(timespan))) + .replace(`{${"from"}}`, encodeURIComponent(String(from))) + .replace(`{${"to"}}`, encodeURIComponent(String(to))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -17402,54 +23440,18 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (timestamp !== undefined) { - localVarQueryParameter['timestamp'] = timestamp; - } - - if (timespan !== undefined) { - localVarQueryParameter['timespan'] = timespan; - } - if (adjusted !== undefined) { localVarQueryParameter['adjusted'] = adjusted; } - if (window !== undefined) { - localVarQueryParameter['window'] = window; - } - - if (seriesType !== undefined) { - localVarQueryParameter['series_type'] = seriesType; - } - - if (expandUnderlying !== undefined) { - localVarQueryParameter['expand_underlying'] = expandUnderlying; - } - - if (order !== undefined) { - localVarQueryParameter['order'] = order; + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } - if (timestampGte !== undefined) { - localVarQueryParameter['timestamp.gte'] = timestampGte; - } - - if (timestampGt !== undefined) { - localVarQueryParameter['timestamp.gt'] = timestampGt; - } - - if (timestampLte !== undefined) { - localVarQueryParameter['timestamp.lte'] = timestampLte; - } - - if (timestampLt !== undefined) { - localVarQueryParameter['timestamp.lt'] = timestampLt; - } - setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -17462,31 +23464,31 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get moving average convergence/divergence (MACD) for a ticker symbol over a given time range. - * @summary Moving Average Convergence/Divergence (MACD) - * @param {string} indicesTicker The ticker symbol for which to get MACD data. - * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. - * @param {GetIndicesMACDTimespanEnum} [timespan] The size of the aggregate time window. - * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. - * @param {number} [shortWindow] The short window size used to calculate MACD data. - * @param {number} [longWindow] The long window size used to calculate MACD data. - * @param {number} [signalWindow] The window size used to calculate the MACD signal line. - * @param {GetIndicesMACDSeriesTypeEnum} [seriesType] The value in the aggregate which will be used to calculate the MACD. i.e. \'close\' will result in using close values to calculate the MACD. - * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. - * @param {GetIndicesMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. - * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 - * @param {string} [timestampGte] Range by timestamp. - * @param {string} [timestampGt] Range by timestamp. - * @param {string} [timestampLte] Range by timestamp. - * @param {string} [timestampLt] Range by timestamp. + * Get the snapshot of all options contracts for an underlying ticker. + * @summary Options Chain + * @param {string} underlyingAsset The underlying ticker symbol of the option contract. + * @param {number} [strikePrice] Query by strike price of a contract. + * @param {string} [expirationDate] Query by contract expiration with date format YYYY-MM-DD. + * @param {GetOptionsChainContractTypeEnum} [contractType] Query by the type of contract. + * @param {number} [strikePriceGte] Range by strike_price. + * @param {number} [strikePriceGt] Range by strike_price. + * @param {number} [strikePriceLte] Range by strike_price. + * @param {number} [strikePriceLt] Range by strike_price. + * @param {string} [expirationDateGte] Range by expiration_date. + * @param {string} [expirationDateGt] Range by expiration_date. + * @param {string} [expirationDateLte] Range by expiration_date. + * @param {string} [expirationDateLt] Range by expiration_date. + * @param {GetOptionsChainOrderEnum} [order] Order results based on the `sort` field. + * @param {number} [limit] Limit the number of results returned, default is 10 and max is 250. + * @param {GetOptionsChainSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getIndicesMACD: async (indicesTicker: string, timestamp?: string, timespan?: GetIndicesMACDTimespanEnum, adjusted?: boolean, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetIndicesMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetIndicesMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'indicesTicker' is not null or undefined - assertParamExists('getIndicesMACD', 'indicesTicker', indicesTicker) - const localVarPath = `/v1/indicators/macd/{indicesTicker}` - .replace(`{${"indicesTicker"}}`, encodeURIComponent(String(indicesTicker))); + getOptionsChain: async (underlyingAsset: string, strikePrice?: number, expirationDate?: string, contractType?: GetOptionsChainContractTypeEnum, strikePriceGte?: number, strikePriceGt?: number, strikePriceLte?: number, strikePriceLt?: number, expirationDateGte?: string, expirationDateGt?: string, expirationDateLte?: string, expirationDateLt?: string, order?: GetOptionsChainOrderEnum, limit?: number, sort?: GetOptionsChainSortEnum, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'underlyingAsset' is not null or undefined + assertParamExists('getOptionsChain', 'underlyingAsset', underlyingAsset) + const localVarPath = `/v3/snapshot/options/{underlyingAsset}` + .replace(`{${"underlyingAsset"}}`, encodeURIComponent(String(underlyingAsset))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -17501,60 +23503,60 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (timestamp !== undefined) { - localVarQueryParameter['timestamp'] = timestamp; + if (strikePrice !== undefined) { + localVarQueryParameter['strike_price'] = strikePrice; } - if (timespan !== undefined) { - localVarQueryParameter['timespan'] = timespan; + if (expirationDate !== undefined) { + localVarQueryParameter['expiration_date'] = expirationDate; } - if (adjusted !== undefined) { - localVarQueryParameter['adjusted'] = adjusted; + if (contractType !== undefined) { + localVarQueryParameter['contract_type'] = contractType; } - if (shortWindow !== undefined) { - localVarQueryParameter['short_window'] = shortWindow; + if (strikePriceGte !== undefined) { + localVarQueryParameter['strike_price.gte'] = strikePriceGte; } - if (longWindow !== undefined) { - localVarQueryParameter['long_window'] = longWindow; + if (strikePriceGt !== undefined) { + localVarQueryParameter['strike_price.gt'] = strikePriceGt; } - if (signalWindow !== undefined) { - localVarQueryParameter['signal_window'] = signalWindow; + if (strikePriceLte !== undefined) { + localVarQueryParameter['strike_price.lte'] = strikePriceLte; } - if (seriesType !== undefined) { - localVarQueryParameter['series_type'] = seriesType; + if (strikePriceLt !== undefined) { + localVarQueryParameter['strike_price.lt'] = strikePriceLt; } - if (expandUnderlying !== undefined) { - localVarQueryParameter['expand_underlying'] = expandUnderlying; + if (expirationDateGte !== undefined) { + localVarQueryParameter['expiration_date.gte'] = expirationDateGte; } - if (order !== undefined) { - localVarQueryParameter['order'] = order; + if (expirationDateGt !== undefined) { + localVarQueryParameter['expiration_date.gt'] = expirationDateGt; } - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; + if (expirationDateLte !== undefined) { + localVarQueryParameter['expiration_date.lte'] = expirationDateLte; } - if (timestampGte !== undefined) { - localVarQueryParameter['timestamp.gte'] = timestampGte; + if (expirationDateLt !== undefined) { + localVarQueryParameter['expiration_date.lt'] = expirationDateLt; } - if (timestampGt !== undefined) { - localVarQueryParameter['timestamp.gt'] = timestampGt; + if (order !== undefined) { + localVarQueryParameter['order'] = order; } - if (timestampLte !== undefined) { - localVarQueryParameter['timestamp.lte'] = timestampLte; + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; } - if (timestampLt !== undefined) { - localVarQueryParameter['timestamp.lt'] = timestampLt; + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; } @@ -17569,21 +23571,18 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the open, close and afterhours values of a index symbol on a certain date. - * @summary Daily Open/Close - * @param {string} indicesTicker The ticker symbol of Index. - * @param {string} date The date of the requested open/close in the format YYYY-MM-DD. + * Get an options contract + * @summary Options Contract + * @param {string} optionsTicker Query for a contract by options ticker. You can learn more about the structure of options tickers [here](https://massive.com/blog/how-to-read-a-stock-options-ticker/). + * @param {string} [asOf] Specify a point in time for the contract as of this date with format YYYY-MM-DD. Defaults to today\'s date. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getIndicesOpenClose: async (indicesTicker: string, date: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'indicesTicker' is not null or undefined - assertParamExists('getIndicesOpenClose', 'indicesTicker', indicesTicker) - // verify required parameter 'date' is not null or undefined - assertParamExists('getIndicesOpenClose', 'date', date) - const localVarPath = `/v1/open-close/{indicesTicker}/{date}` - .replace(`{${"indicesTicker"}}`, encodeURIComponent(String(indicesTicker))) - .replace(`{${"date"}}`, encodeURIComponent(String(date))); + getOptionsContract: async (optionsTicker: string, asOf?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'optionsTicker' is not null or undefined + assertParamExists('getOptionsContract', 'optionsTicker', optionsTicker) + const localVarPath = `/v3/reference/options/contracts/{options_ticker}` + .replace(`{${"options_ticker"}}`, encodeURIComponent(String(optionsTicker))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -17598,6 +23597,10 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (asOf !== undefined) { + localVarQueryParameter['as_of'] = asOf; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -17610,16 +23613,16 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the relative strength index (RSI) for a ticker symbol over a given time range. - * @summary Relative Strength Index (RSI) - * @param {string} indicesTicker The ticker symbol for which to get relative strength index (RSI) data. + * Get the exponential moving average (EMA) for a ticker symbol over a given time range. + * @summary Exponential Moving Average (EMA) + * @param {string} optionsTicker The ticker symbol for which to get exponential moving average (EMA) data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. - * @param {GetIndicesRSITimespanEnum} [timespan] The size of the aggregate time window. - * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. - * @param {number} [window] The window size used to calculate the relative strength index (RSI). - * @param {GetIndicesRSISeriesTypeEnum} [seriesType] The value in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close values to calculate the relative strength index (RSI). + * @param {GetOptionsEMATimespanEnum} [timespan] The size of the aggregate time window. + * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. + * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. + * @param {GetOptionsEMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close prices to calculate the exponential moving average (EMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. - * @param {GetIndicesRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. + * @param {GetOptionsEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. @@ -17628,11 +23631,11 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getIndicesRSI: async (indicesTicker: string, timestamp?: string, timespan?: GetIndicesRSITimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetIndicesRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetIndicesRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'indicesTicker' is not null or undefined - assertParamExists('getIndicesRSI', 'indicesTicker', indicesTicker) - const localVarPath = `/v1/indicators/rsi/{indicesTicker}` - .replace(`{${"indicesTicker"}}`, encodeURIComponent(String(indicesTicker))); + getOptionsEMA: async (optionsTicker: string, timestamp?: string, timespan?: GetOptionsEMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetOptionsEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetOptionsEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'optionsTicker' is not null or undefined + assertParamExists('getOptionsEMA', 'optionsTicker', optionsTicker) + const localVarPath = `/v1/indicators/ema/{optionsTicker}` + .replace(`{${"optionsTicker"}}`, encodeURIComponent(String(optionsTicker))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -17707,16 +23710,18 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the simple moving average (SMA) for a ticker symbol over a given time range. - * @summary Simple Moving Average (SMA) - * @param {string} indicesTicker The ticker symbol for which to get simple moving average (SMA) data. + * Get moving average convergence/divergence (MACD) for a ticker symbol over a given time range. + * @summary Moving Average Convergence/Divergence (MACD) + * @param {string} optionsTicker The ticker symbol for which to get MACD data. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. - * @param {GetIndicesSMATimespanEnum} [timespan] The size of the aggregate time window. - * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. - * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. - * @param {GetIndicesSMASeriesTypeEnum} [seriesType] The value in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close values to calculate the simple moving average (SMA). + * @param {GetOptionsMACDTimespanEnum} [timespan] The size of the aggregate time window. + * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. + * @param {number} [shortWindow] The short window size used to calculate MACD data. + * @param {number} [longWindow] The long window size used to calculate MACD data. + * @param {number} [signalWindow] The window size used to calculate the MACD signal line. + * @param {GetOptionsMACDSeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the MACD. i.e. \'close\' will result in using close prices to calculate the MACD. * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. - * @param {GetIndicesSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. + * @param {GetOptionsMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. @@ -17725,11 +23730,11 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getIndicesSMA: async (indicesTicker: string, timestamp?: string, timespan?: GetIndicesSMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetIndicesSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetIndicesSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'indicesTicker' is not null or undefined - assertParamExists('getIndicesSMA', 'indicesTicker', indicesTicker) - const localVarPath = `/v1/indicators/sma/{indicesTicker}` - .replace(`{${"indicesTicker"}}`, encodeURIComponent(String(indicesTicker))); + getOptionsMACD: async (optionsTicker: string, timestamp?: string, timespan?: GetOptionsMACDTimespanEnum, adjusted?: boolean, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetOptionsMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetOptionsMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'optionsTicker' is not null or undefined + assertParamExists('getOptionsMACD', 'optionsTicker', optionsTicker) + const localVarPath = `/v1/indicators/macd/{optionsTicker}` + .replace(`{${"optionsTicker"}}`, encodeURIComponent(String(optionsTicker))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -17756,8 +23761,16 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['adjusted'] = adjusted; } - if (window !== undefined) { - localVarQueryParameter['window'] = window; + if (shortWindow !== undefined) { + localVarQueryParameter['short_window'] = shortWindow; + } + + if (longWindow !== undefined) { + localVarQueryParameter['long_window'] = longWindow; + } + + if (signalWindow !== undefined) { + localVarQueryParameter['signal_window'] = signalWindow; } if (seriesType !== undefined) { @@ -17804,22 +23817,22 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get a Snapshot of indices data for said tickers - * @summary Indices Snapshot - * @param {string} [tickerAnyOf] Comma separated list of tickers, up to a maximum of 250. If no tickers are passed then all results will be returned in a paginated manner. Warning: The maximum number of characters allowed in a URL are subject to your technology stack. - * @param {string} [ticker] Search a range of tickers lexicographically. - * @param {string} [tickerGte] Range by ticker. - * @param {string} [tickerGt] Range by ticker. - * @param {string} [tickerLte] Range by ticker. - * @param {string} [tickerLt] Range by ticker. - * @param {GetIndicesSnapshotOrderEnum} [order] Order results based on the `sort` field. - * @param {number} [limit] Limit the number of results returned, default is 10 and max is 250. - * @param {GetIndicesSnapshotSortEnum} [sort] Sort field used for ordering. + * Get the open, close and afterhours prices of an options contract on a certain date. + * @summary Daily Open/Close + * @param {string} optionsTicker The ticker symbol of the options contract. + * @param {string} date The date of the requested open/close in the format YYYY-MM-DD. + * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getIndicesSnapshot: async (tickerAnyOf?: string, ticker?: string, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, order?: GetIndicesSnapshotOrderEnum, limit?: number, sort?: GetIndicesSnapshotSortEnum, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/v3/snapshot/indices`; + getOptionsOpenClose: async (optionsTicker: string, date: string, adjusted?: boolean, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'optionsTicker' is not null or undefined + assertParamExists('getOptionsOpenClose', 'optionsTicker', optionsTicker) + // verify required parameter 'date' is not null or undefined + assertParamExists('getOptionsOpenClose', 'date', date) + const localVarPath = `/v1/open-close/{optionsTicker}/{date}` + .replace(`{${"optionsTicker"}}`, encodeURIComponent(String(optionsTicker))) + .replace(`{${"date"}}`, encodeURIComponent(String(date))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -17834,28 +23847,73 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (tickerAnyOf !== undefined) { - localVarQueryParameter['ticker.any_of'] = tickerAnyOf; + if (adjusted !== undefined) { + localVarQueryParameter['adjusted'] = adjusted; } - if (ticker !== undefined) { - localVarQueryParameter['ticker'] = ticker; + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get quotes for an options ticker symbol in a given time range. + * @summary Quotes + * @param {string} optionsTicker The ticker symbol to get quotes for. + * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. + * @param {string} [timestampGte] Range by timestamp. + * @param {string} [timestampGt] Range by timestamp. + * @param {string} [timestampLte] Range by timestamp. + * @param {string} [timestampLt] Range by timestamp. + * @param {GetOptionsQuotesOrderEnum} [order] Order results based on the `sort` field. + * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. + * @param {GetOptionsQuotesSortEnum} [sort] Sort field used for ordering. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getOptionsQuotes: async (optionsTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetOptionsQuotesOrderEnum, limit?: number, sort?: GetOptionsQuotesSortEnum, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'optionsTicker' is not null or undefined + assertParamExists('getOptionsQuotes', 'optionsTicker', optionsTicker) + const localVarPath = `/v3/quotes/{optionsTicker}` + .replace(`{${"optionsTicker"}}`, encodeURIComponent(String(optionsTicker))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; } - if (tickerGte !== undefined) { - localVarQueryParameter['ticker.gte'] = tickerGte; + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + if (timestamp !== undefined) { + localVarQueryParameter['timestamp'] = timestamp; } - if (tickerGt !== undefined) { - localVarQueryParameter['ticker.gt'] = tickerGt; + if (timestampGte !== undefined) { + localVarQueryParameter['timestamp.gte'] = timestampGte; } - if (tickerLte !== undefined) { - localVarQueryParameter['ticker.lte'] = tickerLte; + if (timestampGt !== undefined) { + localVarQueryParameter['timestamp.gt'] = timestampGt; } - if (tickerLt !== undefined) { - localVarQueryParameter['ticker.lt'] = tickerLt; + if (timestampLte !== undefined) { + localVarQueryParameter['timestamp.lte'] = timestampLte; + } + + if (timestampLt !== undefined) { + localVarQueryParameter['timestamp.lt'] = timestampLt; } if (order !== undefined) { @@ -17882,21 +23940,29 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the last trade tick for a cryptocurrency pair. - * @summary Last Trade for a Crypto Pair - * @param {string} from The \"from\" symbol of the pair. - * @param {string} to The \"to\" symbol of the pair. + * Get the relative strength index (RSI) for a ticker symbol over a given time range. + * @summary Relative Strength Index (RSI) + * @param {string} optionsTicker The ticker symbol for which to get relative strength index (RSI) data. + * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. + * @param {GetOptionsRSITimespanEnum} [timespan] The size of the aggregate time window. + * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. + * @param {number} [window] The window size used to calculate the relative strength index (RSI). + * @param {GetOptionsRSISeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close prices to calculate the relative strength index (RSI). + * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. + * @param {GetOptionsRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. + * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 + * @param {string} [timestampGte] Range by timestamp. + * @param {string} [timestampGt] Range by timestamp. + * @param {string} [timestampLte] Range by timestamp. + * @param {string} [timestampLt] Range by timestamp. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getLastCryptoTrade: async (from: string, to: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'from' is not null or undefined - assertParamExists('getLastCryptoTrade', 'from', from) - // verify required parameter 'to' is not null or undefined - assertParamExists('getLastCryptoTrade', 'to', to) - const localVarPath = `/v1/last/crypto/{from}/{to}` - .replace(`{${"from"}}`, encodeURIComponent(String(from))) - .replace(`{${"to"}}`, encodeURIComponent(String(to))); + getOptionsRSI: async (optionsTicker: string, timestamp?: string, timespan?: GetOptionsRSITimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetOptionsRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetOptionsRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'optionsTicker' is not null or undefined + assertParamExists('getOptionsRSI', 'optionsTicker', optionsTicker) + const localVarPath = `/v1/indicators/rsi/{optionsTicker}` + .replace(`{${"optionsTicker"}}`, encodeURIComponent(String(optionsTicker))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -17911,6 +23977,54 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (timestamp !== undefined) { + localVarQueryParameter['timestamp'] = timestamp; + } + + if (timespan !== undefined) { + localVarQueryParameter['timespan'] = timespan; + } + + if (adjusted !== undefined) { + localVarQueryParameter['adjusted'] = adjusted; + } + + if (window !== undefined) { + localVarQueryParameter['window'] = window; + } + + if (seriesType !== undefined) { + localVarQueryParameter['series_type'] = seriesType; + } + + if (expandUnderlying !== undefined) { + localVarQueryParameter['expand_underlying'] = expandUnderlying; + } + + if (order !== undefined) { + localVarQueryParameter['order'] = order; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (timestampGte !== undefined) { + localVarQueryParameter['timestamp.gte'] = timestampGte; + } + + if (timestampGt !== undefined) { + localVarQueryParameter['timestamp.gt'] = timestampGt; + } + + if (timestampLte !== undefined) { + localVarQueryParameter['timestamp.lte'] = timestampLte; + } + + if (timestampLt !== undefined) { + localVarQueryParameter['timestamp.lt'] = timestampLt; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -17923,21 +24037,29 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the last quote tick for a forex currency pair. - * @summary Last Quote for a Currency Pair - * @param {string} from The \"from\" symbol of the pair. - * @param {string} to The \"to\" symbol of the pair. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getLastCurrencyQuote: async (from: string, to: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'from' is not null or undefined - assertParamExists('getLastCurrencyQuote', 'from', from) - // verify required parameter 'to' is not null or undefined - assertParamExists('getLastCurrencyQuote', 'to', to) - const localVarPath = `/v1/last_quote/currencies/{from}/{to}` - .replace(`{${"from"}}`, encodeURIComponent(String(from))) - .replace(`{${"to"}}`, encodeURIComponent(String(to))); + * Get the simple moving average (SMA) for a ticker symbol over a given time range. + * @summary Simple Moving Average (SMA) + * @param {string} optionsTicker The ticker symbol for which to get simple moving average (SMA) data. + * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. + * @param {GetOptionsSMATimespanEnum} [timespan] The size of the aggregate time window. + * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. + * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. + * @param {GetOptionsSMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close prices to calculate the simple moving average (SMA). + * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. + * @param {GetOptionsSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. + * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 + * @param {string} [timestampGte] Range by timestamp. + * @param {string} [timestampGt] Range by timestamp. + * @param {string} [timestampLte] Range by timestamp. + * @param {string} [timestampLt] Range by timestamp. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getOptionsSMA: async (optionsTicker: string, timestamp?: string, timespan?: GetOptionsSMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetOptionsSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetOptionsSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'optionsTicker' is not null or undefined + assertParamExists('getOptionsSMA', 'optionsTicker', optionsTicker) + const localVarPath = `/v1/indicators/sma/{optionsTicker}` + .replace(`{${"optionsTicker"}}`, encodeURIComponent(String(optionsTicker))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -17952,6 +24074,54 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (timestamp !== undefined) { + localVarQueryParameter['timestamp'] = timestamp; + } + + if (timespan !== undefined) { + localVarQueryParameter['timespan'] = timespan; + } + + if (adjusted !== undefined) { + localVarQueryParameter['adjusted'] = adjusted; + } + + if (window !== undefined) { + localVarQueryParameter['window'] = window; + } + + if (seriesType !== undefined) { + localVarQueryParameter['series_type'] = seriesType; + } + + if (expandUnderlying !== undefined) { + localVarQueryParameter['expand_underlying'] = expandUnderlying; + } + + if (order !== undefined) { + localVarQueryParameter['order'] = order; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (timestampGte !== undefined) { + localVarQueryParameter['timestamp.gte'] = timestampGte; + } + + if (timestampGt !== undefined) { + localVarQueryParameter['timestamp.gt'] = timestampGt; + } + + if (timestampLte !== undefined) { + localVarQueryParameter['timestamp.lte'] = timestampLte; + } + + if (timestampLt !== undefined) { + localVarQueryParameter['timestamp.lt'] = timestampLt; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -17964,16 +24134,24 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the most recent trade for a given options contract. - * @summary Last Trade - * @param {string} optionsTicker The ticker symbol of the options contract. + * Get trades for an options ticker symbol in a given time range. + * @summary Trades + * @param {string} optionsTicker The options ticker symbol to get trades for. + * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. + * @param {string} [timestampGte] Range by timestamp. + * @param {string} [timestampGt] Range by timestamp. + * @param {string} [timestampLte] Range by timestamp. + * @param {string} [timestampLt] Range by timestamp. + * @param {GetOptionsTradesOrderEnum} [order] Order results based on the `sort` field. + * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. + * @param {GetOptionsTradesSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getLastOptionsTrade: async (optionsTicker: string, options: RawAxiosRequestConfig = {}): Promise => { + getOptionsTrades: async (optionsTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetOptionsTradesOrderEnum, limit?: number, sort?: GetOptionsTradesSortEnum, options: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'optionsTicker' is not null or undefined - assertParamExists('getLastOptionsTrade', 'optionsTicker', optionsTicker) - const localVarPath = `/v2/last/trade/{optionsTicker}` + assertParamExists('getOptionsTrades', 'optionsTicker', optionsTicker) + const localVarPath = `/v3/trades/{optionsTicker}` .replace(`{${"optionsTicker"}}`, encodeURIComponent(String(optionsTicker))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -17989,6 +24167,38 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (timestamp !== undefined) { + localVarQueryParameter['timestamp'] = timestamp; + } + + if (timestampGte !== undefined) { + localVarQueryParameter['timestamp.gte'] = timestampGte; + } + + if (timestampGt !== undefined) { + localVarQueryParameter['timestamp.gt'] = timestampGt; + } + + if (timestampLte !== undefined) { + localVarQueryParameter['timestamp.lte'] = timestampLte; + } + + if (timestampLt !== undefined) { + localVarQueryParameter['timestamp.lt'] = timestampLt; + } + + if (order !== undefined) { + localVarQueryParameter['order'] = order; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -18001,17 +24211,13 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the most recent NBBO (Quote) tick for a given stock. - * @summary Last Quote - * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. + * US options exchanges and trading venues including traditional options exchanges (CBOE, ISE, etc.), Securities Information Processors (SIP), and other options market infrastructure for derivatives trading. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'999\'. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getLastStocksQuote: async (stocksTicker: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'stocksTicker' is not null or undefined - assertParamExists('getLastStocksQuote', 'stocksTicker', stocksTicker) - const localVarPath = `/v2/last/nbbo/{stocksTicker}` - .replace(`{${"stocksTicker"}}`, encodeURIComponent(String(stocksTicker))); + getOptionsV1Exchanges: async (limit?: number, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/options/v1/exchanges`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -18026,6 +24232,10 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -18038,17 +24248,18 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the most recent trade for a given stock. - * @summary Last Trade - * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. + * Get the previous day\'s open, high, low, and close (OHLC) for the specified cryptocurrency pair. + * @summary Previous Close + * @param {string} cryptoTicker The ticker symbol of the currency pair. + * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getLastStocksTrade: async (stocksTicker: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'stocksTicker' is not null or undefined - assertParamExists('getLastStocksTrade', 'stocksTicker', stocksTicker) - const localVarPath = `/v2/last/trade/{stocksTicker}` - .replace(`{${"stocksTicker"}}`, encodeURIComponent(String(stocksTicker))); + getPreviousCryptoAggregates: async (cryptoTicker: string, adjusted?: boolean, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'cryptoTicker' is not null or undefined + assertParamExists('getPreviousCryptoAggregates', 'cryptoTicker', cryptoTicker) + const localVarPath = `/v2/aggs/ticker/{cryptoTicker}/prev` + .replace(`{${"cryptoTicker"}}`, encodeURIComponent(String(cryptoTicker))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -18063,6 +24274,10 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (adjusted !== undefined) { + localVarQueryParameter['adjusted'] = adjusted; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -18075,13 +24290,18 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get upcoming market holidays and their open/close times. - * @summary Market Holidays + * Get the previous day\'s open, high, low, and close (OHLC) for the specified forex pair. + * @summary Previous Close + * @param {string} forexTicker The ticker symbol of the currency pair. + * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getMarketHolidays: async (options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/v1/marketstatus/upcoming`; + getPreviousForexAggregates: async (forexTicker: string, adjusted?: boolean, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'forexTicker' is not null or undefined + assertParamExists('getPreviousForexAggregates', 'forexTicker', forexTicker) + const localVarPath = `/v2/aggs/ticker/{forexTicker}/prev` + .replace(`{${"forexTicker"}}`, encodeURIComponent(String(forexTicker))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -18096,6 +24316,10 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (adjusted !== undefined) { + localVarQueryParameter['adjusted'] = adjusted; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -18108,13 +24332,17 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the current trading status of the exchanges and overall financial markets. - * @summary Market Status + * Get the previous day\'s open, high, low, and close (OHLC) for the specified index. + * @summary Previous Close + * @param {string} indicesTicker The ticker symbol of Index. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getMarketStatus: async (options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/v1/marketstatus/now`; + getPreviousIndicesAggregates: async (indicesTicker: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'indicesTicker' is not null or undefined + assertParamExists('getPreviousIndicesAggregates', 'indicesTicker', indicesTicker) + const localVarPath = `/v2/aggs/ticker/{indicesTicker}/prev` + .replace(`{${"indicesTicker"}}`, encodeURIComponent(String(indicesTicker))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -18141,21 +24369,18 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the snapshot of an option contract for a stock equity. - * @summary Option Contract - * @param {string} underlyingAsset The underlying ticker symbol of the option contract. - * @param {string} optionContract The option contract identifier. + * Get the previous day\'s open, high, low, and close (OHLC) for the specified option contract. + * @summary Previous Close + * @param {string} optionsTicker The ticker symbol of the options contract. + * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getOptionContract: async (underlyingAsset: string, optionContract: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'underlyingAsset' is not null or undefined - assertParamExists('getOptionContract', 'underlyingAsset', underlyingAsset) - // verify required parameter 'optionContract' is not null or undefined - assertParamExists('getOptionContract', 'optionContract', optionContract) - const localVarPath = `/v3/snapshot/options/{underlyingAsset}/{optionContract}` - .replace(`{${"underlyingAsset"}}`, encodeURIComponent(String(underlyingAsset))) - .replace(`{${"optionContract"}}`, encodeURIComponent(String(optionContract))); + getPreviousOptionsAggregates: async (optionsTicker: string, adjusted?: boolean, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'optionsTicker' is not null or undefined + assertParamExists('getPreviousOptionsAggregates', 'optionsTicker', optionsTicker) + const localVarPath = `/v2/aggs/ticker/{optionsTicker}/prev` + .replace(`{${"optionsTicker"}}`, encodeURIComponent(String(optionsTicker))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -18170,6 +24395,10 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (adjusted !== undefined) { + localVarQueryParameter['adjusted'] = adjusted; + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -18182,36 +24411,18 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get aggregate bars for an option contract over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. - * @summary Aggregates (Bars) - * @param {string} optionsTicker The ticker symbol of the options contract. - * @param {number} multiplier The size of the timespan multiplier. - * @param {GetOptionsAggregatesTimespanEnum} timespan The size of the time window. - * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. - * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. + * Get the previous day\'s open, high, low, and close (OHLC) for the specified stock ticker. + * @summary Previous Close + * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. - * @param {GetOptionsAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). - * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getOptionsAggregates: async (optionsTicker: string, multiplier: number, timespan: GetOptionsAggregatesTimespanEnum, from: string, to: string, adjusted?: boolean, sort?: GetOptionsAggregatesSortEnum, limit?: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'optionsTicker' is not null or undefined - assertParamExists('getOptionsAggregates', 'optionsTicker', optionsTicker) - // verify required parameter 'multiplier' is not null or undefined - assertParamExists('getOptionsAggregates', 'multiplier', multiplier) - // verify required parameter 'timespan' is not null or undefined - assertParamExists('getOptionsAggregates', 'timespan', timespan) - // verify required parameter 'from' is not null or undefined - assertParamExists('getOptionsAggregates', 'from', from) - // verify required parameter 'to' is not null or undefined - assertParamExists('getOptionsAggregates', 'to', to) - const localVarPath = `/v2/aggs/ticker/{optionsTicker}/range/{multiplier}/{timespan}/{from}/{to}` - .replace(`{${"optionsTicker"}}`, encodeURIComponent(String(optionsTicker))) - .replace(`{${"multiplier"}}`, encodeURIComponent(String(multiplier))) - .replace(`{${"timespan"}}`, encodeURIComponent(String(timespan))) - .replace(`{${"from"}}`, encodeURIComponent(String(from))) - .replace(`{${"to"}}`, encodeURIComponent(String(to))); + getPreviousStocksAggregates: async (stocksTicker: string, adjusted?: boolean, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'stocksTicker' is not null or undefined + assertParamExists('getPreviousStocksAggregates', 'stocksTicker', stocksTicker) + const localVarPath = `/v2/aggs/ticker/{stocksTicker}/prev` + .replace(`{${"stocksTicker"}}`, encodeURIComponent(String(stocksTicker))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -18230,14 +24441,6 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['adjusted'] = adjusted; } - if (sort !== undefined) { - localVarQueryParameter['sort'] = sort; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -18250,31 +24453,17 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the snapshot of all options contracts for an underlying ticker. - * @summary Options Chain - * @param {string} underlyingAsset The underlying ticker symbol of the option contract. - * @param {number} [strikePrice] Query by strike price of a contract. - * @param {string} [expirationDate] Query by contract expiration with date format YYYY-MM-DD. - * @param {GetOptionsChainContractTypeEnum} [contractType] Query by the type of contract. - * @param {number} [strikePriceGte] Range by strike_price. - * @param {number} [strikePriceGt] Range by strike_price. - * @param {number} [strikePriceLte] Range by strike_price. - * @param {number} [strikePriceLt] Range by strike_price. - * @param {string} [expirationDateGte] Range by expiration_date. - * @param {string} [expirationDateGt] Range by expiration_date. - * @param {string} [expirationDateLte] Range by expiration_date. - * @param {string} [expirationDateLt] Range by expiration_date. - * @param {GetOptionsChainOrderEnum} [order] Order results based on the `sort` field. - * @param {number} [limit] Limit the number of results returned, default is 10 and max is 250. - * @param {GetOptionsChainSortEnum} [sort] Sort field used for ordering. + * Get a list of tickers related to the queried ticker based on News and Returns data. + * @summary Related Companies + * @param {string} ticker The ticker symbol to search. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getOptionsChain: async (underlyingAsset: string, strikePrice?: number, expirationDate?: string, contractType?: GetOptionsChainContractTypeEnum, strikePriceGte?: number, strikePriceGt?: number, strikePriceLte?: number, strikePriceLt?: number, expirationDateGte?: string, expirationDateGt?: string, expirationDateLte?: string, expirationDateLt?: string, order?: GetOptionsChainOrderEnum, limit?: number, sort?: GetOptionsChainSortEnum, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'underlyingAsset' is not null or undefined - assertParamExists('getOptionsChain', 'underlyingAsset', underlyingAsset) - const localVarPath = `/v3/snapshot/options/{underlyingAsset}` - .replace(`{${"underlyingAsset"}}`, encodeURIComponent(String(underlyingAsset))); + getRelatedCompanies: async (ticker: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'ticker' is not null or undefined + assertParamExists('getRelatedCompanies', 'ticker', ticker) + const localVarPath = `/v1/related-companies/{ticker}` + .replace(`{${"ticker"}}`, encodeURIComponent(String(ticker))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -18289,62 +24478,6 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (strikePrice !== undefined) { - localVarQueryParameter['strike_price'] = strikePrice; - } - - if (expirationDate !== undefined) { - localVarQueryParameter['expiration_date'] = expirationDate; - } - - if (contractType !== undefined) { - localVarQueryParameter['contract_type'] = contractType; - } - - if (strikePriceGte !== undefined) { - localVarQueryParameter['strike_price.gte'] = strikePriceGte; - } - - if (strikePriceGt !== undefined) { - localVarQueryParameter['strike_price.gt'] = strikePriceGt; - } - - if (strikePriceLte !== undefined) { - localVarQueryParameter['strike_price.lte'] = strikePriceLte; - } - - if (strikePriceLt !== undefined) { - localVarQueryParameter['strike_price.lt'] = strikePriceLt; - } - - if (expirationDateGte !== undefined) { - localVarQueryParameter['expiration_date.gte'] = expirationDateGte; - } - - if (expirationDateGt !== undefined) { - localVarQueryParameter['expiration_date.gt'] = expirationDateGt; - } - - if (expirationDateLte !== undefined) { - localVarQueryParameter['expiration_date.lte'] = expirationDateLte; - } - - if (expirationDateLt !== undefined) { - localVarQueryParameter['expiration_date.lt'] = expirationDateLt; - } - - if (order !== undefined) { - localVarQueryParameter['order'] = order; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (sort !== undefined) { - localVarQueryParameter['sort'] = sort; - } - setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -18357,18 +24490,14 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get an options contract - * @summary Options Contract - * @param {string} optionsTicker Query for a contract by options ticker. You can learn more about the structure of options tickers [here](https://polygon.io/blog/how-to-read-a-stock-options-ticker/). - * @param {string} [asOf] Specify a point in time for the contract as of this date with format YYYY-MM-DD. Defaults to today\'s date. + * Get everything needed to visualize the tick-by-tick movement of a list of tickers. + * @summary Summaries + * @param {string} [tickerAnyOf] Comma separated list of tickers. This API currently supports Stocks/Equities, Crypto, Options, and Forex. See <a rel=\"nofollow\" target=\"_blank\" href=\"https://massive.com/docs/stocks/get_v3_reference_tickers\">the tickers endpoint</a> for more details on supported tickers. If no tickers are passed then no results will be returned. Warning: The maximum number of characters allowed in a URL are subject to your technology stack. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getOptionsContract: async (optionsTicker: string, asOf?: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'optionsTicker' is not null or undefined - assertParamExists('getOptionsContract', 'optionsTicker', optionsTicker) - const localVarPath = `/v3/reference/options/contracts/{options_ticker}` - .replace(`{${"options_ticker"}}`, encodeURIComponent(String(optionsTicker))); + getSnapshotSummary: async (tickerAnyOf?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/v1/summaries`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -18383,8 +24512,8 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (asOf !== undefined) { - localVarQueryParameter['as_of'] = asOf; + if (tickerAnyOf !== undefined) { + localVarQueryParameter['ticker.any_of'] = tickerAnyOf; } @@ -18399,29 +24528,23 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the exponential moving average (EMA) for a ticker symbol over a given time range. - * @summary Exponential Moving Average (EMA) - * @param {string} optionsTicker The ticker symbol for which to get exponential moving average (EMA) data. - * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. - * @param {GetOptionsEMATimespanEnum} [timespan] The size of the aggregate time window. - * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. - * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. - * @param {GetOptionsEMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close prices to calculate the exponential moving average (EMA). - * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. - * @param {GetOptionsEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. - * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 - * @param {string} [timestampGte] Range by timestamp. - * @param {string} [timestampGt] Range by timestamp. - * @param {string} [timestampLte] Range by timestamp. - * @param {string} [timestampLt] Range by timestamp. + * Get snapshots for assets of all types + * @summary Universal Snapshot + * @param {string} [ticker] Search a range of tickers lexicographically. + * @param {GetSnapshotsTypeEnum} [type] Query by the type of asset. + * @param {string} [tickerGte] Range by ticker. + * @param {string} [tickerGt] Range by ticker. + * @param {string} [tickerLte] Range by ticker. + * @param {string} [tickerLt] Range by ticker. + * @param {string} [tickerAnyOf] Comma separated list of tickers, up to a maximum of 250. If no tickers are passed then all results will be returned in a paginated manner. Warning: The maximum number of characters allowed in a URL are subject to your technology stack. + * @param {GetSnapshotsOrderEnum} [order] Order results based on the `sort` field. + * @param {number} [limit] Limit the number of results returned, default is 10 and max is 250. + * @param {GetSnapshotsSortEnum} [sort] Sort field used for ordering. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getOptionsEMA: async (optionsTicker: string, timestamp?: string, timespan?: GetOptionsEMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetOptionsEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetOptionsEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'optionsTicker' is not null or undefined - assertParamExists('getOptionsEMA', 'optionsTicker', optionsTicker) - const localVarPath = `/v1/indicators/ema/{optionsTicker}` - .replace(`{${"optionsTicker"}}`, encodeURIComponent(String(optionsTicker))); + getSnapshots: async (ticker?: string, type?: GetSnapshotsTypeEnum, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, tickerAnyOf?: string, order?: GetSnapshotsOrderEnum, limit?: number, sort?: GetSnapshotsSortEnum, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/v3/snapshot`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -18436,28 +24559,32 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (timestamp !== undefined) { - localVarQueryParameter['timestamp'] = timestamp; + if (ticker !== undefined) { + localVarQueryParameter['ticker'] = ticker; } - if (timespan !== undefined) { - localVarQueryParameter['timespan'] = timespan; + if (type !== undefined) { + localVarQueryParameter['type'] = type; } - if (adjusted !== undefined) { - localVarQueryParameter['adjusted'] = adjusted; + if (tickerGte !== undefined) { + localVarQueryParameter['ticker.gte'] = tickerGte; } - if (window !== undefined) { - localVarQueryParameter['window'] = window; + if (tickerGt !== undefined) { + localVarQueryParameter['ticker.gt'] = tickerGt; } - if (seriesType !== undefined) { - localVarQueryParameter['series_type'] = seriesType; + if (tickerLte !== undefined) { + localVarQueryParameter['ticker.lte'] = tickerLte; } - if (expandUnderlying !== undefined) { - localVarQueryParameter['expand_underlying'] = expandUnderlying; + if (tickerLt !== undefined) { + localVarQueryParameter['ticker.lt'] = tickerLt; + } + + if (tickerAnyOf !== undefined) { + localVarQueryParameter['ticker.any_of'] = tickerAnyOf; } if (order !== undefined) { @@ -18468,20 +24595,76 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['limit'] = limit; } - if (timestampGte !== undefined) { - localVarQueryParameter['timestamp.gte'] = timestampGte; + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; } - if (timestampGt !== undefined) { - localVarQueryParameter['timestamp.gt'] = timestampGt; + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Get aggregate bars for a stock over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. + * @summary Aggregates (Bars) + * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. + * @param {number} multiplier The size of the timespan multiplier. + * @param {GetStocksAggregatesTimespanEnum} timespan The size of the time window. + * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. + * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. + * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. + * @param {GetStocksAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). + * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://massive.com/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getStocksAggregates: async (stocksTicker: string, multiplier: number, timespan: GetStocksAggregatesTimespanEnum, from: string, to: string, adjusted?: boolean, sort?: GetStocksAggregatesSortEnum, limit?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'stocksTicker' is not null or undefined + assertParamExists('getStocksAggregates', 'stocksTicker', stocksTicker) + // verify required parameter 'multiplier' is not null or undefined + assertParamExists('getStocksAggregates', 'multiplier', multiplier) + // verify required parameter 'timespan' is not null or undefined + assertParamExists('getStocksAggregates', 'timespan', timespan) + // verify required parameter 'from' is not null or undefined + assertParamExists('getStocksAggregates', 'from', from) + // verify required parameter 'to' is not null or undefined + assertParamExists('getStocksAggregates', 'to', to) + const localVarPath = `/v2/aggs/ticker/{stocksTicker}/range/{multiplier}/{timespan}/{from}/{to}` + .replace(`{${"stocksTicker"}}`, encodeURIComponent(String(stocksTicker))) + .replace(`{${"multiplier"}}`, encodeURIComponent(String(multiplier))) + .replace(`{${"timespan"}}`, encodeURIComponent(String(timespan))) + .replace(`{${"from"}}`, encodeURIComponent(String(from))) + .replace(`{${"to"}}`, encodeURIComponent(String(to))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; } - if (timestampLte !== undefined) { - localVarQueryParameter['timestamp.lte'] = timestampLte; + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + if (adjusted !== undefined) { + localVarQueryParameter['adjusted'] = adjusted; } - if (timestampLt !== undefined) { - localVarQueryParameter['timestamp.lt'] = timestampLt; + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; } @@ -18496,18 +24679,16 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get moving average convergence/divergence (MACD) for a ticker symbol over a given time range. - * @summary Moving Average Convergence/Divergence (MACD) - * @param {string} optionsTicker The ticker symbol for which to get MACD data. + * Get the exponential moving average (EMA) for a ticker symbol over a given time range. + * @summary Exponential Moving Average (EMA) + * @param {string} stockTicker Specify a case-sensitive ticker symbol for which to get exponential moving average (EMA) data. For example, AAPL represents Apple Inc. * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. - * @param {GetOptionsMACDTimespanEnum} [timespan] The size of the aggregate time window. - * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. - * @param {number} [shortWindow] The short window size used to calculate MACD data. - * @param {number} [longWindow] The long window size used to calculate MACD data. - * @param {number} [signalWindow] The window size used to calculate the MACD signal line. - * @param {GetOptionsMACDSeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the MACD. i.e. \'close\' will result in using close prices to calculate the MACD. + * @param {GetStocksEMATimespanEnum} [timespan] The size of the aggregate time window. + * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. + * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. + * @param {GetStocksEMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close prices to calculate the exponential moving average (EMA). * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. - * @param {GetOptionsMACDOrderEnum} [order] The order in which to return the results, ordered by timestamp. + * @param {GetStocksEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 * @param {string} [timestampGte] Range by timestamp. * @param {string} [timestampGt] Range by timestamp. @@ -18516,11 +24697,11 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getOptionsMACD: async (optionsTicker: string, timestamp?: string, timespan?: GetOptionsMACDTimespanEnum, adjusted?: boolean, shortWindow?: number, longWindow?: number, signalWindow?: number, seriesType?: GetOptionsMACDSeriesTypeEnum, expandUnderlying?: boolean, order?: GetOptionsMACDOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'optionsTicker' is not null or undefined - assertParamExists('getOptionsMACD', 'optionsTicker', optionsTicker) - const localVarPath = `/v1/indicators/macd/{optionsTicker}` - .replace(`{${"optionsTicker"}}`, encodeURIComponent(String(optionsTicker))); + getStocksEMA: async (stockTicker: string, timestamp?: string, timespan?: GetStocksEMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetStocksEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetStocksEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'stockTicker' is not null or undefined + assertParamExists('getStocksEMA', 'stockTicker', stockTicker) + const localVarPath = `/v1/indicators/ema/{stockTicker}` + .replace(`{${"stockTicker"}}`, encodeURIComponent(String(stockTicker))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -18547,16 +24728,8 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['adjusted'] = adjusted; } - if (shortWindow !== undefined) { - localVarQueryParameter['short_window'] = shortWindow; - } - - if (longWindow !== undefined) { - localVarQueryParameter['long_window'] = longWindow; - } - - if (signalWindow !== undefined) { - localVarQueryParameter['signal_window'] = signalWindow; + if (window !== undefined) { + localVarQueryParameter['window'] = window; } if (seriesType !== undefined) { @@ -18603,22 +24776,49 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the open, close and afterhours prices of an options contract on a certain date. - * @summary Daily Open/Close - * @param {string} optionsTicker The ticker symbol of the options contract. - * @param {string} date The date of the requested open/close in the format YYYY-MM-DD. - * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. + * A comprehensive financial dataset containing quarterly and annual balance sheet data for public companies. Includes detailed asset, liability, and equity positions representing the company\'s financial position at specific points in time. Balance sheet data represents point-in-time snapshots rather than cumulative flows, showing what the company owns, owes, and shareholders\' equity as of each period end date. + * @param {string} [cik] The company\'s Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company\'s CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup). + * @param {string} [cikAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [cikGt] Filter greater than the value. + * @param {string} [cikGte] Filter greater than or equal to the value. + * @param {string} [cikLt] Filter less than the value. + * @param {string} [cikLte] Filter less than or equal to the value. + * @param {string} [tickers] Filter for arrays that contain the value. + * @param {string} [tickersAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickersAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [periodEnd] The last date of the reporting period, representing the specific point in time when the balance sheet snapshot was taken. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDate] The date when the financial statement was filed with the SEC. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {number} [fiscalYear] The fiscal year for the reporting period. Value must be a floating point number. + * @param {number} [fiscalYearGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [fiscalYearGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalYearLt] Filter less than the value. Value must be a floating point number. + * @param {number} [fiscalYearLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalQuarter] The fiscal quarter number (1, 2, 3, or 4) for the reporting period. Value must be a floating point number. + * @param {number} [fiscalQuarterGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [fiscalQuarterGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalQuarterLt] Filter less than the value. Value must be a floating point number. + * @param {number} [fiscalQuarterLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {string} [timeframe] The reporting period type. Possible values include: quarterly, annual. + * @param {string} [timeframeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [timeframeGt] Filter greater than the value. + * @param {string} [timeframeGte] Filter greater than or equal to the value. + * @param {string} [timeframeLt] Filter less than the value. + * @param {string} [timeframeLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'period_end\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getOptionsOpenClose: async (optionsTicker: string, date: string, adjusted?: boolean, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'optionsTicker' is not null or undefined - assertParamExists('getOptionsOpenClose', 'optionsTicker', optionsTicker) - // verify required parameter 'date' is not null or undefined - assertParamExists('getOptionsOpenClose', 'date', date) - const localVarPath = `/v1/open-close/{optionsTicker}/{date}` - .replace(`{${"optionsTicker"}}`, encodeURIComponent(String(optionsTicker))) - .replace(`{${"date"}}`, encodeURIComponent(String(date))); + getStocksFinancialsV1BalanceSheets: async (cik?: string, cikAnyOf?: string, cikGt?: string, cikGte?: string, cikLt?: string, cikLte?: string, tickers?: string, tickersAllOf?: string, tickersAnyOf?: string, periodEnd?: string, periodEndGt?: string, periodEndGte?: string, periodEndLt?: string, periodEndLte?: string, filingDate?: string, filingDateGt?: string, filingDateGte?: string, filingDateLt?: string, filingDateLte?: string, fiscalYear?: number, fiscalYearGt?: number, fiscalYearGte?: number, fiscalYearLt?: number, fiscalYearLte?: number, fiscalQuarter?: number, fiscalQuarterGt?: number, fiscalQuarterGte?: number, fiscalQuarterLt?: number, fiscalQuarterLte?: number, timeframe?: string, timeframeAnyOf?: string, timeframeGt?: string, timeframeGte?: string, timeframeLt?: string, timeframeLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/stocks/financials/v1/balance-sheets`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -18633,77 +24833,144 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (adjusted !== undefined) { - localVarQueryParameter['adjusted'] = adjusted; + if (cik !== undefined) { + localVarQueryParameter['cik'] = cik; } + if (cikAnyOf !== undefined) { + localVarQueryParameter['cik.any_of'] = cikAnyOf; + } - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + if (cikGt !== undefined) { + localVarQueryParameter['cik.gt'] = cikGt; + } - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get quotes for an options ticker symbol in a given time range. - * @summary Quotes - * @param {string} optionsTicker The ticker symbol to get quotes for. - * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. - * @param {string} [timestampGte] Range by timestamp. - * @param {string} [timestampGt] Range by timestamp. - * @param {string} [timestampLte] Range by timestamp. - * @param {string} [timestampLt] Range by timestamp. - * @param {GetOptionsQuotesOrderEnum} [order] Order results based on the `sort` field. - * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. - * @param {GetOptionsQuotesSortEnum} [sort] Sort field used for ordering. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getOptionsQuotes: async (optionsTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetOptionsQuotesOrderEnum, limit?: number, sort?: GetOptionsQuotesSortEnum, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'optionsTicker' is not null or undefined - assertParamExists('getOptionsQuotes', 'optionsTicker', optionsTicker) - const localVarPath = `/v3/quotes/{optionsTicker}` - .replace(`{${"optionsTicker"}}`, encodeURIComponent(String(optionsTicker))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; + if (cikGte !== undefined) { + localVarQueryParameter['cik.gte'] = cikGte; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; + if (cikLt !== undefined) { + localVarQueryParameter['cik.lt'] = cikLt; + } - // authentication apiKey required - await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (cikLte !== undefined) { + localVarQueryParameter['cik.lte'] = cikLte; + } - if (timestamp !== undefined) { - localVarQueryParameter['timestamp'] = timestamp; + if (tickers !== undefined) { + localVarQueryParameter['tickers'] = tickers; } - if (timestampGte !== undefined) { - localVarQueryParameter['timestamp.gte'] = timestampGte; + if (tickersAllOf !== undefined) { + localVarQueryParameter['tickers.all_of'] = tickersAllOf; } - if (timestampGt !== undefined) { - localVarQueryParameter['timestamp.gt'] = timestampGt; + if (tickersAnyOf !== undefined) { + localVarQueryParameter['tickers.any_of'] = tickersAnyOf; } - if (timestampLte !== undefined) { - localVarQueryParameter['timestamp.lte'] = timestampLte; + if (periodEnd !== undefined) { + localVarQueryParameter['period_end'] = periodEnd; } - if (timestampLt !== undefined) { - localVarQueryParameter['timestamp.lt'] = timestampLt; + if (periodEndGt !== undefined) { + localVarQueryParameter['period_end.gt'] = periodEndGt; } - if (order !== undefined) { - localVarQueryParameter['order'] = order; + if (periodEndGte !== undefined) { + localVarQueryParameter['period_end.gte'] = periodEndGte; + } + + if (periodEndLt !== undefined) { + localVarQueryParameter['period_end.lt'] = periodEndLt; + } + + if (periodEndLte !== undefined) { + localVarQueryParameter['period_end.lte'] = periodEndLte; + } + + if (filingDate !== undefined) { + localVarQueryParameter['filing_date'] = filingDate; + } + + if (filingDateGt !== undefined) { + localVarQueryParameter['filing_date.gt'] = filingDateGt; + } + + if (filingDateGte !== undefined) { + localVarQueryParameter['filing_date.gte'] = filingDateGte; + } + + if (filingDateLt !== undefined) { + localVarQueryParameter['filing_date.lt'] = filingDateLt; + } + + if (filingDateLte !== undefined) { + localVarQueryParameter['filing_date.lte'] = filingDateLte; + } + + if (fiscalYear !== undefined) { + localVarQueryParameter['fiscal_year'] = fiscalYear; + } + + if (fiscalYearGt !== undefined) { + localVarQueryParameter['fiscal_year.gt'] = fiscalYearGt; + } + + if (fiscalYearGte !== undefined) { + localVarQueryParameter['fiscal_year.gte'] = fiscalYearGte; + } + + if (fiscalYearLt !== undefined) { + localVarQueryParameter['fiscal_year.lt'] = fiscalYearLt; + } + + if (fiscalYearLte !== undefined) { + localVarQueryParameter['fiscal_year.lte'] = fiscalYearLte; + } + + if (fiscalQuarter !== undefined) { + localVarQueryParameter['fiscal_quarter'] = fiscalQuarter; + } + + if (fiscalQuarterGt !== undefined) { + localVarQueryParameter['fiscal_quarter.gt'] = fiscalQuarterGt; + } + + if (fiscalQuarterGte !== undefined) { + localVarQueryParameter['fiscal_quarter.gte'] = fiscalQuarterGte; + } + + if (fiscalQuarterLt !== undefined) { + localVarQueryParameter['fiscal_quarter.lt'] = fiscalQuarterLt; + } + + if (fiscalQuarterLte !== undefined) { + localVarQueryParameter['fiscal_quarter.lte'] = fiscalQuarterLte; + } + + if (timeframe !== undefined) { + localVarQueryParameter['timeframe'] = timeframe; + } + + if (timeframeAnyOf !== undefined) { + localVarQueryParameter['timeframe.any_of'] = timeframeAnyOf; + } + + if (timeframeGt !== undefined) { + localVarQueryParameter['timeframe.gt'] = timeframeGt; + } + + if (timeframeGte !== undefined) { + localVarQueryParameter['timeframe.gte'] = timeframeGte; + } + + if (timeframeLt !== undefined) { + localVarQueryParameter['timeframe.lt'] = timeframeLt; + } + + if (timeframeLte !== undefined) { + localVarQueryParameter['timeframe.lte'] = timeframeLte; } if (limit !== undefined) { @@ -18726,29 +24993,49 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the relative strength index (RSI) for a ticker symbol over a given time range. - * @summary Relative Strength Index (RSI) - * @param {string} optionsTicker The ticker symbol for which to get relative strength index (RSI) data. - * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. - * @param {GetOptionsRSITimespanEnum} [timespan] The size of the aggregate time window. - * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. - * @param {number} [window] The window size used to calculate the relative strength index (RSI). - * @param {GetOptionsRSISeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the relative strength index. i.e. \'close\' will result in using close prices to calculate the relative strength index (RSI). - * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. - * @param {GetOptionsRSIOrderEnum} [order] The order in which to return the results, ordered by timestamp. - * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 - * @param {string} [timestampGte] Range by timestamp. - * @param {string} [timestampGt] Range by timestamp. - * @param {string} [timestampLte] Range by timestamp. - * @param {string} [timestampLt] Range by timestamp. + * A comprehensive financial dataset containing quarterly, annual, and trailing twelve-month cash flow statement data for public companies. Includes detailed operating, investing, and financing cash flows with proper TTM calculations that sum all cash flow components over four quarters. TTM records are validated to ensure exactly four distinct quarters spanning 250-400 days for accurate trailing twelve-month cash flow analysis. + * @param {string} [cik] The company\'s Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company’s CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup). + * @param {string} [cikAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [cikGt] Filter greater than the value. + * @param {string} [cikGte] Filter greater than or equal to the value. + * @param {string} [cikLt] Filter less than the value. + * @param {string} [cikLte] Filter less than or equal to the value. + * @param {string} [periodEnd] The last date of the reporting period (formatted as YYYY-MM-DD). Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDate] The date when the financial statement was filed with the SEC. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [tickers] Filter for arrays that contain the value. + * @param {string} [tickersAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickersAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {number} [fiscalYear] The fiscal year for the reporting period. Value must be a floating point number. + * @param {number} [fiscalYearGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [fiscalYearGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalYearLt] Filter less than the value. Value must be a floating point number. + * @param {number} [fiscalYearLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalQuarter] The fiscal quarter number (1, 2, 3, or 4) for the reporting period. Value must be a floating point number. + * @param {number} [fiscalQuarterGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [fiscalQuarterGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalQuarterLt] Filter less than the value. Value must be a floating point number. + * @param {number} [fiscalQuarterLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {string} [timeframe] The reporting period type. Possible values include: quarterly, annual, trailing_twelve_months. + * @param {string} [timeframeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [timeframeGt] Filter greater than the value. + * @param {string} [timeframeGte] Filter greater than or equal to the value. + * @param {string} [timeframeLt] Filter less than the value. + * @param {string} [timeframeLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'period_end\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getOptionsRSI: async (optionsTicker: string, timestamp?: string, timespan?: GetOptionsRSITimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetOptionsRSISeriesTypeEnum, expandUnderlying?: boolean, order?: GetOptionsRSIOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'optionsTicker' is not null or undefined - assertParamExists('getOptionsRSI', 'optionsTicker', optionsTicker) - const localVarPath = `/v1/indicators/rsi/{optionsTicker}` - .replace(`{${"optionsTicker"}}`, encodeURIComponent(String(optionsTicker))); + getStocksFinancialsV1CashFlowStatements: async (cik?: string, cikAnyOf?: string, cikGt?: string, cikGte?: string, cikLt?: string, cikLte?: string, periodEnd?: string, periodEndGt?: string, periodEndGte?: string, periodEndLt?: string, periodEndLte?: string, filingDate?: string, filingDateGt?: string, filingDateGte?: string, filingDateLt?: string, filingDateLte?: string, tickers?: string, tickersAllOf?: string, tickersAnyOf?: string, fiscalYear?: number, fiscalYearGt?: number, fiscalYearGte?: number, fiscalYearLt?: number, fiscalYearLte?: number, fiscalQuarter?: number, fiscalQuarterGt?: number, fiscalQuarterGte?: number, fiscalQuarterLt?: number, fiscalQuarterLte?: number, timeframe?: string, timeframeAnyOf?: string, timeframeGt?: string, timeframeGte?: string, timeframeLt?: string, timeframeLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/stocks/financials/v1/cash-flow-statements`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -18763,52 +25050,152 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (timestamp !== undefined) { - localVarQueryParameter['timestamp'] = timestamp; + if (cik !== undefined) { + localVarQueryParameter['cik'] = cik; } - if (timespan !== undefined) { - localVarQueryParameter['timespan'] = timespan; + if (cikAnyOf !== undefined) { + localVarQueryParameter['cik.any_of'] = cikAnyOf; } - if (adjusted !== undefined) { - localVarQueryParameter['adjusted'] = adjusted; + if (cikGt !== undefined) { + localVarQueryParameter['cik.gt'] = cikGt; } - if (window !== undefined) { - localVarQueryParameter['window'] = window; + if (cikGte !== undefined) { + localVarQueryParameter['cik.gte'] = cikGte; } - if (seriesType !== undefined) { - localVarQueryParameter['series_type'] = seriesType; + if (cikLt !== undefined) { + localVarQueryParameter['cik.lt'] = cikLt; } - if (expandUnderlying !== undefined) { - localVarQueryParameter['expand_underlying'] = expandUnderlying; + if (cikLte !== undefined) { + localVarQueryParameter['cik.lte'] = cikLte; + } + + if (periodEnd !== undefined) { + localVarQueryParameter['period_end'] = periodEnd; + } + + if (periodEndGt !== undefined) { + localVarQueryParameter['period_end.gt'] = periodEndGt; + } + + if (periodEndGte !== undefined) { + localVarQueryParameter['period_end.gte'] = periodEndGte; + } + + if (periodEndLt !== undefined) { + localVarQueryParameter['period_end.lt'] = periodEndLt; + } + + if (periodEndLte !== undefined) { + localVarQueryParameter['period_end.lte'] = periodEndLte; + } + + if (filingDate !== undefined) { + localVarQueryParameter['filing_date'] = filingDate; + } + + if (filingDateGt !== undefined) { + localVarQueryParameter['filing_date.gt'] = filingDateGt; + } + + if (filingDateGte !== undefined) { + localVarQueryParameter['filing_date.gte'] = filingDateGte; + } + + if (filingDateLt !== undefined) { + localVarQueryParameter['filing_date.lt'] = filingDateLt; + } + + if (filingDateLte !== undefined) { + localVarQueryParameter['filing_date.lte'] = filingDateLte; + } + + if (tickers !== undefined) { + localVarQueryParameter['tickers'] = tickers; + } + + if (tickersAllOf !== undefined) { + localVarQueryParameter['tickers.all_of'] = tickersAllOf; + } + + if (tickersAnyOf !== undefined) { + localVarQueryParameter['tickers.any_of'] = tickersAnyOf; + } + + if (fiscalYear !== undefined) { + localVarQueryParameter['fiscal_year'] = fiscalYear; + } + + if (fiscalYearGt !== undefined) { + localVarQueryParameter['fiscal_year.gt'] = fiscalYearGt; + } + + if (fiscalYearGte !== undefined) { + localVarQueryParameter['fiscal_year.gte'] = fiscalYearGte; + } + + if (fiscalYearLt !== undefined) { + localVarQueryParameter['fiscal_year.lt'] = fiscalYearLt; + } + + if (fiscalYearLte !== undefined) { + localVarQueryParameter['fiscal_year.lte'] = fiscalYearLte; + } + + if (fiscalQuarter !== undefined) { + localVarQueryParameter['fiscal_quarter'] = fiscalQuarter; + } + + if (fiscalQuarterGt !== undefined) { + localVarQueryParameter['fiscal_quarter.gt'] = fiscalQuarterGt; + } + + if (fiscalQuarterGte !== undefined) { + localVarQueryParameter['fiscal_quarter.gte'] = fiscalQuarterGte; + } + + if (fiscalQuarterLt !== undefined) { + localVarQueryParameter['fiscal_quarter.lt'] = fiscalQuarterLt; + } + + if (fiscalQuarterLte !== undefined) { + localVarQueryParameter['fiscal_quarter.lte'] = fiscalQuarterLte; + } + + if (timeframe !== undefined) { + localVarQueryParameter['timeframe'] = timeframe; + } + + if (timeframeAnyOf !== undefined) { + localVarQueryParameter['timeframe.any_of'] = timeframeAnyOf; } - if (order !== undefined) { - localVarQueryParameter['order'] = order; + if (timeframeGt !== undefined) { + localVarQueryParameter['timeframe.gt'] = timeframeGt; } - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; + if (timeframeGte !== undefined) { + localVarQueryParameter['timeframe.gte'] = timeframeGte; } - if (timestampGte !== undefined) { - localVarQueryParameter['timestamp.gte'] = timestampGte; + if (timeframeLt !== undefined) { + localVarQueryParameter['timeframe.lt'] = timeframeLt; } - if (timestampGt !== undefined) { - localVarQueryParameter['timestamp.gt'] = timestampGt; + if (timeframeLte !== undefined) { + localVarQueryParameter['timeframe.lte'] = timeframeLte; } - if (timestampLte !== undefined) { - localVarQueryParameter['timestamp.lte'] = timestampLte; + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; } - if (timestampLt !== undefined) { - localVarQueryParameter['timestamp.lt'] = timestampLt; + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; } @@ -18823,29 +25210,49 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the simple moving average (SMA) for a ticker symbol over a given time range. - * @summary Simple Moving Average (SMA) - * @param {string} optionsTicker The ticker symbol for which to get simple moving average (SMA) data. - * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. - * @param {GetOptionsSMATimespanEnum} [timespan] The size of the aggregate time window. - * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. - * @param {number} [window] The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. - * @param {GetOptionsSMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the simple moving average. i.e. \'close\' will result in using close prices to calculate the simple moving average (SMA). - * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. - * @param {GetOptionsSMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. - * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 - * @param {string} [timestampGte] Range by timestamp. - * @param {string} [timestampGt] Range by timestamp. - * @param {string} [timestampLte] Range by timestamp. - * @param {string} [timestampLt] Range by timestamp. + * A comprehensive database of income statement financial data for public companies, including key metrics such as revenue, expenses, and net income for various reporting periods. + * @param {string} [cik] The company\'s Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company’s CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup). + * @param {string} [cikAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [cikGt] Filter greater than the value. + * @param {string} [cikGte] Filter greater than or equal to the value. + * @param {string} [cikLt] Filter less than the value. + * @param {string} [cikLte] Filter less than or equal to the value. + * @param {string} [tickers] Filter for arrays that contain the value. + * @param {string} [tickersAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickersAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [periodEnd] The last date of the reporting period (formatted as YYYY-MM-DD). Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDate] The date when the financial statement was filed with the SEC. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {number} [fiscalYear] The fiscal year for the reporting period. Value must be a floating point number. + * @param {number} [fiscalYearGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [fiscalYearGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalYearLt] Filter less than the value. Value must be a floating point number. + * @param {number} [fiscalYearLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalQuarter] The fiscal quarter number (1, 2, 3, or 4) for the reporting period. Value must be a floating point number. + * @param {number} [fiscalQuarterGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [fiscalQuarterGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalQuarterLt] Filter less than the value. Value must be a floating point number. + * @param {number} [fiscalQuarterLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {string} [timeframe] The reporting period type. Possible values include: quarterly, annual, trailing_twelve_months. + * @param {string} [timeframeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [timeframeGt] Filter greater than the value. + * @param {string} [timeframeGte] Filter greater than or equal to the value. + * @param {string} [timeframeLt] Filter less than the value. + * @param {string} [timeframeLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'period_end\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getOptionsSMA: async (optionsTicker: string, timestamp?: string, timespan?: GetOptionsSMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetOptionsSMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetOptionsSMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'optionsTicker' is not null or undefined - assertParamExists('getOptionsSMA', 'optionsTicker', optionsTicker) - const localVarPath = `/v1/indicators/sma/{optionsTicker}` - .replace(`{${"optionsTicker"}}`, encodeURIComponent(String(optionsTicker))); + getStocksFinancialsV1IncomeStatements: async (cik?: string, cikAnyOf?: string, cikGt?: string, cikGte?: string, cikLt?: string, cikLte?: string, tickers?: string, tickersAllOf?: string, tickersAnyOf?: string, periodEnd?: string, periodEndGt?: string, periodEndGte?: string, periodEndLt?: string, periodEndLte?: string, filingDate?: string, filingDateGt?: string, filingDateGte?: string, filingDateLt?: string, filingDateLte?: string, fiscalYear?: number, fiscalYearGt?: number, fiscalYearGte?: number, fiscalYearLt?: number, fiscalYearLte?: number, fiscalQuarter?: number, fiscalQuarterGt?: number, fiscalQuarterGte?: number, fiscalQuarterLt?: number, fiscalQuarterLte?: number, timeframe?: string, timeframeAnyOf?: string, timeframeGt?: string, timeframeGte?: string, timeframeLt?: string, timeframeLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/stocks/financials/v1/income-statements`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -18860,251 +25267,153 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (timestamp !== undefined) { - localVarQueryParameter['timestamp'] = timestamp; + if (cik !== undefined) { + localVarQueryParameter['cik'] = cik; } - if (timespan !== undefined) { - localVarQueryParameter['timespan'] = timespan; + if (cikAnyOf !== undefined) { + localVarQueryParameter['cik.any_of'] = cikAnyOf; } - if (adjusted !== undefined) { - localVarQueryParameter['adjusted'] = adjusted; + if (cikGt !== undefined) { + localVarQueryParameter['cik.gt'] = cikGt; } - if (window !== undefined) { - localVarQueryParameter['window'] = window; + if (cikGte !== undefined) { + localVarQueryParameter['cik.gte'] = cikGte; } - if (seriesType !== undefined) { - localVarQueryParameter['series_type'] = seriesType; + if (cikLt !== undefined) { + localVarQueryParameter['cik.lt'] = cikLt; } - if (expandUnderlying !== undefined) { - localVarQueryParameter['expand_underlying'] = expandUnderlying; + if (cikLte !== undefined) { + localVarQueryParameter['cik.lte'] = cikLte; } - if (order !== undefined) { - localVarQueryParameter['order'] = order; + if (tickers !== undefined) { + localVarQueryParameter['tickers'] = tickers; } - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; + if (tickersAllOf !== undefined) { + localVarQueryParameter['tickers.all_of'] = tickersAllOf; } - if (timestampGte !== undefined) { - localVarQueryParameter['timestamp.gte'] = timestampGte; + if (tickersAnyOf !== undefined) { + localVarQueryParameter['tickers.any_of'] = tickersAnyOf; } - if (timestampGt !== undefined) { - localVarQueryParameter['timestamp.gt'] = timestampGt; + if (periodEnd !== undefined) { + localVarQueryParameter['period_end'] = periodEnd; } - if (timestampLte !== undefined) { - localVarQueryParameter['timestamp.lte'] = timestampLte; + if (periodEndGt !== undefined) { + localVarQueryParameter['period_end.gt'] = periodEndGt; } - if (timestampLt !== undefined) { - localVarQueryParameter['timestamp.lt'] = timestampLt; + if (periodEndGte !== undefined) { + localVarQueryParameter['period_end.gte'] = periodEndGte; } - - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get trades for an options ticker symbol in a given time range. - * @summary Trades - * @param {string} optionsTicker The options ticker symbol to get trades for. - * @param {string} [timestamp] Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. - * @param {string} [timestampGte] Range by timestamp. - * @param {string} [timestampGt] Range by timestamp. - * @param {string} [timestampLte] Range by timestamp. - * @param {string} [timestampLt] Range by timestamp. - * @param {GetOptionsTradesOrderEnum} [order] Order results based on the `sort` field. - * @param {number} [limit] Limit the number of results returned, default is 1000 and max is 50000. - * @param {GetOptionsTradesSortEnum} [sort] Sort field used for ordering. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getOptionsTrades: async (optionsTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetOptionsTradesOrderEnum, limit?: number, sort?: GetOptionsTradesSortEnum, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'optionsTicker' is not null or undefined - assertParamExists('getOptionsTrades', 'optionsTicker', optionsTicker) - const localVarPath = `/v3/trades/{optionsTicker}` - .replace(`{${"optionsTicker"}}`, encodeURIComponent(String(optionsTicker))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; + if (periodEndLt !== undefined) { + localVarQueryParameter['period_end.lt'] = periodEndLt; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - // authentication apiKey required - await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - - if (timestamp !== undefined) { - localVarQueryParameter['timestamp'] = timestamp; + if (periodEndLte !== undefined) { + localVarQueryParameter['period_end.lte'] = periodEndLte; } - if (timestampGte !== undefined) { - localVarQueryParameter['timestamp.gte'] = timestampGte; + if (filingDate !== undefined) { + localVarQueryParameter['filing_date'] = filingDate; } - if (timestampGt !== undefined) { - localVarQueryParameter['timestamp.gt'] = timestampGt; + if (filingDateGt !== undefined) { + localVarQueryParameter['filing_date.gt'] = filingDateGt; } - if (timestampLte !== undefined) { - localVarQueryParameter['timestamp.lte'] = timestampLte; + if (filingDateGte !== undefined) { + localVarQueryParameter['filing_date.gte'] = filingDateGte; } - if (timestampLt !== undefined) { - localVarQueryParameter['timestamp.lt'] = timestampLt; + if (filingDateLt !== undefined) { + localVarQueryParameter['filing_date.lt'] = filingDateLt; } - if (order !== undefined) { - localVarQueryParameter['order'] = order; + if (filingDateLte !== undefined) { + localVarQueryParameter['filing_date.lte'] = filingDateLte; } - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; + if (fiscalYear !== undefined) { + localVarQueryParameter['fiscal_year'] = fiscalYear; } - if (sort !== undefined) { - localVarQueryParameter['sort'] = sort; + if (fiscalYearGt !== undefined) { + localVarQueryParameter['fiscal_year.gt'] = fiscalYearGt; } + if (fiscalYearGte !== undefined) { + localVarQueryParameter['fiscal_year.gte'] = fiscalYearGte; + } - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get the previous day\'s open, high, low, and close (OHLC) for the specified cryptocurrency pair. - * @summary Previous Close - * @param {string} cryptoTicker The ticker symbol of the currency pair. - * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getPreviousCryptoAggregates: async (cryptoTicker: string, adjusted?: boolean, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'cryptoTicker' is not null or undefined - assertParamExists('getPreviousCryptoAggregates', 'cryptoTicker', cryptoTicker) - const localVarPath = `/v2/aggs/ticker/{cryptoTicker}/prev` - .replace(`{${"cryptoTicker"}}`, encodeURIComponent(String(cryptoTicker))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; + if (fiscalYearLt !== undefined) { + localVarQueryParameter['fiscal_year.lt'] = fiscalYearLt; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; + if (fiscalYearLte !== undefined) { + localVarQueryParameter['fiscal_year.lte'] = fiscalYearLte; + } - // authentication apiKey required - await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (fiscalQuarter !== undefined) { + localVarQueryParameter['fiscal_quarter'] = fiscalQuarter; + } - if (adjusted !== undefined) { - localVarQueryParameter['adjusted'] = adjusted; + if (fiscalQuarterGt !== undefined) { + localVarQueryParameter['fiscal_quarter.gt'] = fiscalQuarterGt; } + if (fiscalQuarterGte !== undefined) { + localVarQueryParameter['fiscal_quarter.gte'] = fiscalQuarterGte; + } - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + if (fiscalQuarterLt !== undefined) { + localVarQueryParameter['fiscal_quarter.lt'] = fiscalQuarterLt; + } - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get the previous day\'s open, high, low, and close (OHLC) for the specified forex pair. - * @summary Previous Close - * @param {string} forexTicker The ticker symbol of the currency pair. - * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getPreviousForexAggregates: async (forexTicker: string, adjusted?: boolean, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'forexTicker' is not null or undefined - assertParamExists('getPreviousForexAggregates', 'forexTicker', forexTicker) - const localVarPath = `/v2/aggs/ticker/{forexTicker}/prev` - .replace(`{${"forexTicker"}}`, encodeURIComponent(String(forexTicker))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; + if (fiscalQuarterLte !== undefined) { + localVarQueryParameter['fiscal_quarter.lte'] = fiscalQuarterLte; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; + if (timeframe !== undefined) { + localVarQueryParameter['timeframe'] = timeframe; + } - // authentication apiKey required - await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (timeframeAnyOf !== undefined) { + localVarQueryParameter['timeframe.any_of'] = timeframeAnyOf; + } - if (adjusted !== undefined) { - localVarQueryParameter['adjusted'] = adjusted; + if (timeframeGt !== undefined) { + localVarQueryParameter['timeframe.gt'] = timeframeGt; } + if (timeframeGte !== undefined) { + localVarQueryParameter['timeframe.gte'] = timeframeGte; + } - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + if (timeframeLt !== undefined) { + localVarQueryParameter['timeframe.lt'] = timeframeLt; + } - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get the previous day\'s open, high, low, and close (OHLC) for the specified index. - * @summary Previous Close - * @param {string} indicesTicker The ticker symbol of Index. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getPreviousIndicesAggregates: async (indicesTicker: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'indicesTicker' is not null or undefined - assertParamExists('getPreviousIndicesAggregates', 'indicesTicker', indicesTicker) - const localVarPath = `/v2/aggs/ticker/{indicesTicker}/prev` - .replace(`{${"indicesTicker"}}`, encodeURIComponent(String(indicesTicker))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; + if (timeframeLte !== undefined) { + localVarQueryParameter['timeframe.lte'] = timeframeLte; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } - // authentication apiKey required - await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; + } @@ -19118,18 +25427,126 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get the previous day\'s open, high, low, and close (OHLC) for the specified option contract. - * @summary Previous Close - * @param {string} optionsTicker The ticker symbol of the options contract. - * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. + * A comprehensive financial ratios dataset providing key valuation, profitability, liquidity, and leverage metrics for public companies. Combines data from income statements, balance sheets, and cash flow statements with daily stock prices to calculate ratios on a daily basis. Uses trailing twelve months (TTM) data for income/cash flow metrics and quarterly data for balance sheet items. Fundamental data updates are applied starting from each filing\'s period end date. Market cap calculations use point-in-time shares outstanding for historical accuracy. + * @param {string} [ticker] Stock ticker symbol for the company. + * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickerGt] Filter greater than the value. + * @param {string} [tickerGte] Filter greater than or equal to the value. + * @param {string} [tickerLt] Filter less than the value. + * @param {string} [tickerLte] Filter less than or equal to the value. + * @param {string} [cik] Central Index Key (CIK) number assigned by the SEC to identify the company. + * @param {string} [cikAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [cikGt] Filter greater than the value. + * @param {string} [cikGte] Filter greater than or equal to the value. + * @param {string} [cikLt] Filter less than the value. + * @param {string} [cikLte] Filter less than or equal to the value. + * @param {number} [price] Stock price used in ratio calculations, typically the closing price for the given date. Value must be a floating point number. + * @param {number} [priceGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [priceGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [priceLt] Filter less than the value. Value must be a floating point number. + * @param {number} [priceLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [averageVolume] Average trading volume over the last 30 trading days, providing context for liquidity. Value must be a floating point number. + * @param {number} [averageVolumeGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [averageVolumeGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [averageVolumeLt] Filter less than the value. Value must be a floating point number. + * @param {number} [averageVolumeLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [marketCap] Market capitalization, calculated as stock price multiplied by total shares outstanding. Value must be a floating point number. + * @param {number} [marketCapGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [marketCapGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [marketCapLt] Filter less than the value. Value must be a floating point number. + * @param {number} [marketCapLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [earningsPerShare] Earnings per share, calculated as net income available to common shareholders divided by weighted shares outstanding. Value must be a floating point number. + * @param {number} [earningsPerShareGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [earningsPerShareGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [earningsPerShareLt] Filter less than the value. Value must be a floating point number. + * @param {number} [earningsPerShareLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [priceToEarnings] Price-to-earnings ratio, calculated as stock price divided by earnings per share. Only calculated when earnings per share is positive. Value must be a floating point number. + * @param {number} [priceToEarningsGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [priceToEarningsGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [priceToEarningsLt] Filter less than the value. Value must be a floating point number. + * @param {number} [priceToEarningsLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [priceToBook] Price-to-book ratio, calculated as stock price divided by book value per share, comparing market value to book value. Value must be a floating point number. + * @param {number} [priceToBookGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [priceToBookGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [priceToBookLt] Filter less than the value. Value must be a floating point number. + * @param {number} [priceToBookLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [priceToSales] Price-to-sales ratio, calculated as stock price divided by revenue per share, measuring valuation relative to sales. Value must be a floating point number. + * @param {number} [priceToSalesGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [priceToSalesGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [priceToSalesLt] Filter less than the value. Value must be a floating point number. + * @param {number} [priceToSalesLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [priceToCashFlow] Price-to-cash-flow ratio, calculated as stock price divided by operating cash flow per share. Only calculated when operating cash flow per share is positive. Value must be a floating point number. + * @param {number} [priceToCashFlowGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [priceToCashFlowGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [priceToCashFlowLt] Filter less than the value. Value must be a floating point number. + * @param {number} [priceToCashFlowLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [priceToFreeCashFlow] Price-to-free-cash-flow ratio, calculated as stock price divided by free cash flow per share. Only calculated when free cash flow per share is positive. Value must be a floating point number. + * @param {number} [priceToFreeCashFlowGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [priceToFreeCashFlowGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [priceToFreeCashFlowLt] Filter less than the value. Value must be a floating point number. + * @param {number} [priceToFreeCashFlowLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [dividendYield] Dividend yield, calculated as annual dividends per share divided by stock price, measuring the income return on investment. Value must be a floating point number. + * @param {number} [dividendYieldGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [dividendYieldGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [dividendYieldLt] Filter less than the value. Value must be a floating point number. + * @param {number} [dividendYieldLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [returnOnAssets] Return on assets ratio, calculated as net income divided by total assets, measuring how efficiently a company uses its assets to generate profit. Value must be a floating point number. + * @param {number} [returnOnAssetsGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [returnOnAssetsGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [returnOnAssetsLt] Filter less than the value. Value must be a floating point number. + * @param {number} [returnOnAssetsLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [returnOnEquity] Return on equity ratio, calculated as net income divided by total shareholders\' equity, measuring profitability relative to shareholders\' equity. Value must be a floating point number. + * @param {number} [returnOnEquityGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [returnOnEquityGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [returnOnEquityLt] Filter less than the value. Value must be a floating point number. + * @param {number} [returnOnEquityLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [debtToEquity] Debt-to-equity ratio, calculated as total debt (current debt plus long-term debt) divided by total shareholders\' equity, measuring financial leverage. Value must be a floating point number. + * @param {number} [debtToEquityGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [debtToEquityGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [debtToEquityLt] Filter less than the value. Value must be a floating point number. + * @param {number} [debtToEquityLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [current] Current ratio, calculated as total current assets divided by total current liabilities, measuring short-term liquidity. Value must be a floating point number. + * @param {number} [currentGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [currentGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [currentLt] Filter less than the value. Value must be a floating point number. + * @param {number} [currentLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quick] Quick ratio (acid-test ratio), calculated as (current assets minus inventories) divided by current liabilities, measuring immediate liquidity. Value must be a floating point number. + * @param {number} [quickGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quickGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quickLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quickLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [cash] Cash ratio, calculated as cash and cash equivalents divided by current liabilities, measuring the most liquid form of liquidity coverage. Value must be a floating point number. + * @param {number} [cashGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [cashGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [cashLt] Filter less than the value. Value must be a floating point number. + * @param {number} [cashLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [evToSales] Enterprise value to sales ratio, calculated as enterprise value divided by revenue, measuring company valuation relative to sales. Value must be a floating point number. + * @param {number} [evToSalesGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [evToSalesGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [evToSalesLt] Filter less than the value. Value must be a floating point number. + * @param {number} [evToSalesLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [evToEbitda] Enterprise value to EBITDA ratio, calculated as enterprise value divided by EBITDA, measuring company valuation relative to earnings before interest, taxes, depreciation, and amortization. Value must be a floating point number. + * @param {number} [evToEbitdaGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [evToEbitdaGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [evToEbitdaLt] Filter less than the value. Value must be a floating point number. + * @param {number} [evToEbitdaLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [enterpriseValue] Enterprise value, calculated as market capitalization plus total debt minus cash and cash equivalents, representing total company value. Value must be a floating point number. + * @param {number} [enterpriseValueGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [enterpriseValueGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [enterpriseValueLt] Filter less than the value. Value must be a floating point number. + * @param {number} [enterpriseValueLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [freeCashFlow] Free cash flow, calculated as operating cash flow minus capital expenditures (purchase of property, plant, and equipment). Value must be a floating point number. + * @param {number} [freeCashFlowGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [freeCashFlowGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [freeCashFlowLt] Filter less than the value. Value must be a floating point number. + * @param {number} [freeCashFlowLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'ticker\' if not specified. The sort order defaults to \'asc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getPreviousOptionsAggregates: async (optionsTicker: string, adjusted?: boolean, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'optionsTicker' is not null or undefined - assertParamExists('getPreviousOptionsAggregates', 'optionsTicker', optionsTicker) - const localVarPath = `/v2/aggs/ticker/{optionsTicker}/prev` - .replace(`{${"optionsTicker"}}`, encodeURIComponent(String(optionsTicker))); + getStocksFinancialsV1Ratios: async (ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, cik?: string, cikAnyOf?: string, cikGt?: string, cikGte?: string, cikLt?: string, cikLte?: string, price?: number, priceGt?: number, priceGte?: number, priceLt?: number, priceLte?: number, averageVolume?: number, averageVolumeGt?: number, averageVolumeGte?: number, averageVolumeLt?: number, averageVolumeLte?: number, marketCap?: number, marketCapGt?: number, marketCapGte?: number, marketCapLt?: number, marketCapLte?: number, earningsPerShare?: number, earningsPerShareGt?: number, earningsPerShareGte?: number, earningsPerShareLt?: number, earningsPerShareLte?: number, priceToEarnings?: number, priceToEarningsGt?: number, priceToEarningsGte?: number, priceToEarningsLt?: number, priceToEarningsLte?: number, priceToBook?: number, priceToBookGt?: number, priceToBookGte?: number, priceToBookLt?: number, priceToBookLte?: number, priceToSales?: number, priceToSalesGt?: number, priceToSalesGte?: number, priceToSalesLt?: number, priceToSalesLte?: number, priceToCashFlow?: number, priceToCashFlowGt?: number, priceToCashFlowGte?: number, priceToCashFlowLt?: number, priceToCashFlowLte?: number, priceToFreeCashFlow?: number, priceToFreeCashFlowGt?: number, priceToFreeCashFlowGte?: number, priceToFreeCashFlowLt?: number, priceToFreeCashFlowLte?: number, dividendYield?: number, dividendYieldGt?: number, dividendYieldGte?: number, dividendYieldLt?: number, dividendYieldLte?: number, returnOnAssets?: number, returnOnAssetsGt?: number, returnOnAssetsGte?: number, returnOnAssetsLt?: number, returnOnAssetsLte?: number, returnOnEquity?: number, returnOnEquityGt?: number, returnOnEquityGte?: number, returnOnEquityLt?: number, returnOnEquityLte?: number, debtToEquity?: number, debtToEquityGt?: number, debtToEquityGte?: number, debtToEquityLt?: number, debtToEquityLte?: number, current?: number, currentGt?: number, currentGte?: number, currentLt?: number, currentLte?: number, quick?: number, quickGt?: number, quickGte?: number, quickLt?: number, quickLte?: number, cash?: number, cashGt?: number, cashGte?: number, cashLt?: number, cashLte?: number, evToSales?: number, evToSalesGt?: number, evToSalesGte?: number, evToSalesLt?: number, evToSalesLte?: number, evToEbitda?: number, evToEbitdaGt?: number, evToEbitdaGte?: number, evToEbitdaLt?: number, evToEbitdaLte?: number, enterpriseValue?: number, enterpriseValueGt?: number, enterpriseValueGte?: number, enterpriseValueLt?: number, enterpriseValueLte?: number, freeCashFlow?: number, freeCashFlowGt?: number, freeCashFlowGte?: number, freeCashFlowLt?: number, freeCashFlowLte?: number, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/stocks/financials/v1/ratios`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -19144,373 +25561,460 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati // authentication apiKey required await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) - if (adjusted !== undefined) { - localVarQueryParameter['adjusted'] = adjusted; + if (ticker !== undefined) { + localVarQueryParameter['ticker'] = ticker; } + if (tickerAnyOf !== undefined) { + localVarQueryParameter['ticker.any_of'] = tickerAnyOf; + } - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + if (tickerGt !== undefined) { + localVarQueryParameter['ticker.gt'] = tickerGt; + } - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get the previous day\'s open, high, low, and close (OHLC) for the specified stock ticker. - * @summary Previous Close - * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. - * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getPreviousStocksAggregates: async (stocksTicker: string, adjusted?: boolean, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'stocksTicker' is not null or undefined - assertParamExists('getPreviousStocksAggregates', 'stocksTicker', stocksTicker) - const localVarPath = `/v2/aggs/ticker/{stocksTicker}/prev` - .replace(`{${"stocksTicker"}}`, encodeURIComponent(String(stocksTicker))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; + if (tickerGte !== undefined) { + localVarQueryParameter['ticker.gte'] = tickerGte; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; + if (tickerLt !== undefined) { + localVarQueryParameter['ticker.lt'] = tickerLt; + } - // authentication apiKey required - await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (tickerLte !== undefined) { + localVarQueryParameter['ticker.lte'] = tickerLte; + } - if (adjusted !== undefined) { - localVarQueryParameter['adjusted'] = adjusted; + if (cik !== undefined) { + localVarQueryParameter['cik'] = cik; } + if (cikAnyOf !== undefined) { + localVarQueryParameter['cik.any_of'] = cikAnyOf; + } - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + if (cikGt !== undefined) { + localVarQueryParameter['cik.gt'] = cikGt; + } - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get a list of tickers related to the queried ticker based on News and Returns data. - * @summary Related Companies - * @param {string} ticker The ticker symbol to search. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getRelatedCompanies: async (ticker: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'ticker' is not null or undefined - assertParamExists('getRelatedCompanies', 'ticker', ticker) - const localVarPath = `/v1/related-companies/{ticker}` - .replace(`{${"ticker"}}`, encodeURIComponent(String(ticker))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; + if (cikGte !== undefined) { + localVarQueryParameter['cik.gte'] = cikGte; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; + if (cikLt !== undefined) { + localVarQueryParameter['cik.lt'] = cikLt; + } - // authentication apiKey required - await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (cikLte !== undefined) { + localVarQueryParameter['cik.lte'] = cikLte; + } + if (price !== undefined) { + localVarQueryParameter['price'] = price; + } - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + if (priceGt !== undefined) { + localVarQueryParameter['price.gt'] = priceGt; + } - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get everything needed to visualize the tick-by-tick movement of a list of tickers. - * @summary Summaries - * @param {string} [tickerAnyOf] Comma separated list of tickers. This API currently supports Stocks/Equities, Crypto, Options, and Forex. See <a rel=\"nofollow\" target=\"_blank\" href=\"https://polygon.io/docs/stocks/get_v3_reference_tickers\">the tickers endpoint</a> for more details on supported tickers. If no tickers are passed then no results will be returned. Warning: The maximum number of characters allowed in a URL are subject to your technology stack. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getSnapshotSummary: async (tickerAnyOf?: string, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/v1/summaries`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; + if (priceGte !== undefined) { + localVarQueryParameter['price.gte'] = priceGte; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; + if (priceLt !== undefined) { + localVarQueryParameter['price.lt'] = priceLt; + } - // authentication apiKey required - await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (priceLte !== undefined) { + localVarQueryParameter['price.lte'] = priceLte; + } - if (tickerAnyOf !== undefined) { - localVarQueryParameter['ticker.any_of'] = tickerAnyOf; + if (averageVolume !== undefined) { + localVarQueryParameter['average_volume'] = averageVolume; + } + + if (averageVolumeGt !== undefined) { + localVarQueryParameter['average_volume.gt'] = averageVolumeGt; + } + + if (averageVolumeGte !== undefined) { + localVarQueryParameter['average_volume.gte'] = averageVolumeGte; + } + + if (averageVolumeLt !== undefined) { + localVarQueryParameter['average_volume.lt'] = averageVolumeLt; + } + + if (averageVolumeLte !== undefined) { + localVarQueryParameter['average_volume.lte'] = averageVolumeLte; + } + + if (marketCap !== undefined) { + localVarQueryParameter['market_cap'] = marketCap; + } + + if (marketCapGt !== undefined) { + localVarQueryParameter['market_cap.gt'] = marketCapGt; + } + + if (marketCapGte !== undefined) { + localVarQueryParameter['market_cap.gte'] = marketCapGte; + } + + if (marketCapLt !== undefined) { + localVarQueryParameter['market_cap.lt'] = marketCapLt; + } + + if (marketCapLte !== undefined) { + localVarQueryParameter['market_cap.lte'] = marketCapLte; + } + + if (earningsPerShare !== undefined) { + localVarQueryParameter['earnings_per_share'] = earningsPerShare; + } + + if (earningsPerShareGt !== undefined) { + localVarQueryParameter['earnings_per_share.gt'] = earningsPerShareGt; + } + + if (earningsPerShareGte !== undefined) { + localVarQueryParameter['earnings_per_share.gte'] = earningsPerShareGte; + } + + if (earningsPerShareLt !== undefined) { + localVarQueryParameter['earnings_per_share.lt'] = earningsPerShareLt; + } + + if (earningsPerShareLte !== undefined) { + localVarQueryParameter['earnings_per_share.lte'] = earningsPerShareLte; + } + + if (priceToEarnings !== undefined) { + localVarQueryParameter['price_to_earnings'] = priceToEarnings; + } + + if (priceToEarningsGt !== undefined) { + localVarQueryParameter['price_to_earnings.gt'] = priceToEarningsGt; + } + + if (priceToEarningsGte !== undefined) { + localVarQueryParameter['price_to_earnings.gte'] = priceToEarningsGte; + } + + if (priceToEarningsLt !== undefined) { + localVarQueryParameter['price_to_earnings.lt'] = priceToEarningsLt; + } + + if (priceToEarningsLte !== undefined) { + localVarQueryParameter['price_to_earnings.lte'] = priceToEarningsLte; + } + + if (priceToBook !== undefined) { + localVarQueryParameter['price_to_book'] = priceToBook; + } + + if (priceToBookGt !== undefined) { + localVarQueryParameter['price_to_book.gt'] = priceToBookGt; + } + + if (priceToBookGte !== undefined) { + localVarQueryParameter['price_to_book.gte'] = priceToBookGte; + } + + if (priceToBookLt !== undefined) { + localVarQueryParameter['price_to_book.lt'] = priceToBookLt; + } + + if (priceToBookLte !== undefined) { + localVarQueryParameter['price_to_book.lte'] = priceToBookLte; + } + + if (priceToSales !== undefined) { + localVarQueryParameter['price_to_sales'] = priceToSales; + } + + if (priceToSalesGt !== undefined) { + localVarQueryParameter['price_to_sales.gt'] = priceToSalesGt; + } + + if (priceToSalesGte !== undefined) { + localVarQueryParameter['price_to_sales.gte'] = priceToSalesGte; + } + + if (priceToSalesLt !== undefined) { + localVarQueryParameter['price_to_sales.lt'] = priceToSalesLt; + } + + if (priceToSalesLte !== undefined) { + localVarQueryParameter['price_to_sales.lte'] = priceToSalesLte; + } + + if (priceToCashFlow !== undefined) { + localVarQueryParameter['price_to_cash_flow'] = priceToCashFlow; + } + + if (priceToCashFlowGt !== undefined) { + localVarQueryParameter['price_to_cash_flow.gt'] = priceToCashFlowGt; + } + + if (priceToCashFlowGte !== undefined) { + localVarQueryParameter['price_to_cash_flow.gte'] = priceToCashFlowGte; + } + + if (priceToCashFlowLt !== undefined) { + localVarQueryParameter['price_to_cash_flow.lt'] = priceToCashFlowLt; + } + + if (priceToCashFlowLte !== undefined) { + localVarQueryParameter['price_to_cash_flow.lte'] = priceToCashFlowLte; + } + + if (priceToFreeCashFlow !== undefined) { + localVarQueryParameter['price_to_free_cash_flow'] = priceToFreeCashFlow; + } + + if (priceToFreeCashFlowGt !== undefined) { + localVarQueryParameter['price_to_free_cash_flow.gt'] = priceToFreeCashFlowGt; + } + + if (priceToFreeCashFlowGte !== undefined) { + localVarQueryParameter['price_to_free_cash_flow.gte'] = priceToFreeCashFlowGte; + } + + if (priceToFreeCashFlowLt !== undefined) { + localVarQueryParameter['price_to_free_cash_flow.lt'] = priceToFreeCashFlowLt; + } + + if (priceToFreeCashFlowLte !== undefined) { + localVarQueryParameter['price_to_free_cash_flow.lte'] = priceToFreeCashFlowLte; + } + + if (dividendYield !== undefined) { + localVarQueryParameter['dividend_yield'] = dividendYield; + } + + if (dividendYieldGt !== undefined) { + localVarQueryParameter['dividend_yield.gt'] = dividendYieldGt; + } + + if (dividendYieldGte !== undefined) { + localVarQueryParameter['dividend_yield.gte'] = dividendYieldGte; + } + + if (dividendYieldLt !== undefined) { + localVarQueryParameter['dividend_yield.lt'] = dividendYieldLt; + } + + if (dividendYieldLte !== undefined) { + localVarQueryParameter['dividend_yield.lte'] = dividendYieldLte; + } + + if (returnOnAssets !== undefined) { + localVarQueryParameter['return_on_assets'] = returnOnAssets; + } + + if (returnOnAssetsGt !== undefined) { + localVarQueryParameter['return_on_assets.gt'] = returnOnAssetsGt; + } + + if (returnOnAssetsGte !== undefined) { + localVarQueryParameter['return_on_assets.gte'] = returnOnAssetsGte; + } + + if (returnOnAssetsLt !== undefined) { + localVarQueryParameter['return_on_assets.lt'] = returnOnAssetsLt; + } + + if (returnOnAssetsLte !== undefined) { + localVarQueryParameter['return_on_assets.lte'] = returnOnAssetsLte; + } + + if (returnOnEquity !== undefined) { + localVarQueryParameter['return_on_equity'] = returnOnEquity; + } + + if (returnOnEquityGt !== undefined) { + localVarQueryParameter['return_on_equity.gt'] = returnOnEquityGt; + } + + if (returnOnEquityGte !== undefined) { + localVarQueryParameter['return_on_equity.gte'] = returnOnEquityGte; + } + + if (returnOnEquityLt !== undefined) { + localVarQueryParameter['return_on_equity.lt'] = returnOnEquityLt; + } + + if (returnOnEquityLte !== undefined) { + localVarQueryParameter['return_on_equity.lte'] = returnOnEquityLte; + } + + if (debtToEquity !== undefined) { + localVarQueryParameter['debt_to_equity'] = debtToEquity; + } + + if (debtToEquityGt !== undefined) { + localVarQueryParameter['debt_to_equity.gt'] = debtToEquityGt; } + if (debtToEquityGte !== undefined) { + localVarQueryParameter['debt_to_equity.gte'] = debtToEquityGte; + } - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + if (debtToEquityLt !== undefined) { + localVarQueryParameter['debt_to_equity.lt'] = debtToEquityLt; + } - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get snapshots for assets of all types - * @summary Universal Snapshot - * @param {string} [ticker] Search a range of tickers lexicographically. - * @param {GetSnapshotsTypeEnum} [type] Query by the type of asset. - * @param {string} [tickerGte] Range by ticker. - * @param {string} [tickerGt] Range by ticker. - * @param {string} [tickerLte] Range by ticker. - * @param {string} [tickerLt] Range by ticker. - * @param {string} [tickerAnyOf] Comma separated list of tickers, up to a maximum of 250. If no tickers are passed then all results will be returned in a paginated manner. Warning: The maximum number of characters allowed in a URL are subject to your technology stack. - * @param {GetSnapshotsOrderEnum} [order] Order results based on the `sort` field. - * @param {number} [limit] Limit the number of results returned, default is 10 and max is 250. - * @param {GetSnapshotsSortEnum} [sort] Sort field used for ordering. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getSnapshots: async (ticker?: string, type?: GetSnapshotsTypeEnum, tickerGte?: string, tickerGt?: string, tickerLte?: string, tickerLt?: string, tickerAnyOf?: string, order?: GetSnapshotsOrderEnum, limit?: number, sort?: GetSnapshotsSortEnum, options: RawAxiosRequestConfig = {}): Promise => { - const localVarPath = `/v3/snapshot`; - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; + if (debtToEquityLte !== undefined) { + localVarQueryParameter['debt_to_equity.lte'] = debtToEquityLte; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; + if (current !== undefined) { + localVarQueryParameter['current'] = current; + } - // authentication apiKey required - await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (currentGt !== undefined) { + localVarQueryParameter['current.gt'] = currentGt; + } - if (ticker !== undefined) { - localVarQueryParameter['ticker'] = ticker; + if (currentGte !== undefined) { + localVarQueryParameter['current.gte'] = currentGte; } - if (type !== undefined) { - localVarQueryParameter['type'] = type; + if (currentLt !== undefined) { + localVarQueryParameter['current.lt'] = currentLt; } - if (tickerGte !== undefined) { - localVarQueryParameter['ticker.gte'] = tickerGte; + if (currentLte !== undefined) { + localVarQueryParameter['current.lte'] = currentLte; } - if (tickerGt !== undefined) { - localVarQueryParameter['ticker.gt'] = tickerGt; + if (quick !== undefined) { + localVarQueryParameter['quick'] = quick; } - if (tickerLte !== undefined) { - localVarQueryParameter['ticker.lte'] = tickerLte; + if (quickGt !== undefined) { + localVarQueryParameter['quick.gt'] = quickGt; } - if (tickerLt !== undefined) { - localVarQueryParameter['ticker.lt'] = tickerLt; + if (quickGte !== undefined) { + localVarQueryParameter['quick.gte'] = quickGte; } - if (tickerAnyOf !== undefined) { - localVarQueryParameter['ticker.any_of'] = tickerAnyOf; + if (quickLt !== undefined) { + localVarQueryParameter['quick.lt'] = quickLt; } - if (order !== undefined) { - localVarQueryParameter['order'] = order; + if (quickLte !== undefined) { + localVarQueryParameter['quick.lte'] = quickLte; } - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; + if (cash !== undefined) { + localVarQueryParameter['cash'] = cash; } - if (sort !== undefined) { - localVarQueryParameter['sort'] = sort; + if (cashGt !== undefined) { + localVarQueryParameter['cash.gt'] = cashGt; } + if (cashGte !== undefined) { + localVarQueryParameter['cash.gte'] = cashGte; + } - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + if (cashLt !== undefined) { + localVarQueryParameter['cash.lt'] = cashLt; + } - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get aggregate bars for a stock over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. - * @summary Aggregates (Bars) - * @param {string} stocksTicker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. - * @param {number} multiplier The size of the timespan multiplier. - * @param {GetStocksAggregatesTimespanEnum} timespan The size of the time window. - * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. - * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. - * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. - * @param {GetStocksAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). - * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getStocksAggregates: async (stocksTicker: string, multiplier: number, timespan: GetStocksAggregatesTimespanEnum, from: string, to: string, adjusted?: boolean, sort?: GetStocksAggregatesSortEnum, limit?: number, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'stocksTicker' is not null or undefined - assertParamExists('getStocksAggregates', 'stocksTicker', stocksTicker) - // verify required parameter 'multiplier' is not null or undefined - assertParamExists('getStocksAggregates', 'multiplier', multiplier) - // verify required parameter 'timespan' is not null or undefined - assertParamExists('getStocksAggregates', 'timespan', timespan) - // verify required parameter 'from' is not null or undefined - assertParamExists('getStocksAggregates', 'from', from) - // verify required parameter 'to' is not null or undefined - assertParamExists('getStocksAggregates', 'to', to) - const localVarPath = `/v2/aggs/ticker/{stocksTicker}/range/{multiplier}/{timespan}/{from}/{to}` - .replace(`{${"stocksTicker"}}`, encodeURIComponent(String(stocksTicker))) - .replace(`{${"multiplier"}}`, encodeURIComponent(String(multiplier))) - .replace(`{${"timespan"}}`, encodeURIComponent(String(timespan))) - .replace(`{${"from"}}`, encodeURIComponent(String(from))) - .replace(`{${"to"}}`, encodeURIComponent(String(to))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; + if (cashLte !== undefined) { + localVarQueryParameter['cash.lte'] = cashLte; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; + if (evToSales !== undefined) { + localVarQueryParameter['ev_to_sales'] = evToSales; + } - // authentication apiKey required - await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (evToSalesGt !== undefined) { + localVarQueryParameter['ev_to_sales.gt'] = evToSalesGt; + } - if (adjusted !== undefined) { - localVarQueryParameter['adjusted'] = adjusted; + if (evToSalesGte !== undefined) { + localVarQueryParameter['ev_to_sales.gte'] = evToSalesGte; } - if (sort !== undefined) { - localVarQueryParameter['sort'] = sort; + if (evToSalesLt !== undefined) { + localVarQueryParameter['ev_to_sales.lt'] = evToSalesLt; } - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; + if (evToSalesLte !== undefined) { + localVarQueryParameter['ev_to_sales.lte'] = evToSalesLte; } + if (evToEbitda !== undefined) { + localVarQueryParameter['ev_to_ebitda'] = evToEbitda; + } - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + if (evToEbitdaGt !== undefined) { + localVarQueryParameter['ev_to_ebitda.gt'] = evToEbitdaGt; + } - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * Get the exponential moving average (EMA) for a ticker symbol over a given time range. - * @summary Exponential Moving Average (EMA) - * @param {string} stockTicker Specify a case-sensitive ticker symbol for which to get exponential moving average (EMA) data. For example, AAPL represents Apple Inc. - * @param {string} [timestamp] Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. - * @param {GetStocksEMATimespanEnum} [timespan] The size of the aggregate time window. - * @param {boolean} [adjusted] Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. - * @param {number} [window] The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. - * @param {GetStocksEMASeriesTypeEnum} [seriesType] The price in the aggregate which will be used to calculate the exponential moving average. i.e. \'close\' will result in using close prices to calculate the exponential moving average (EMA). - * @param {boolean} [expandUnderlying] Whether or not to include the aggregates used to calculate this indicator in the response. - * @param {GetStocksEMAOrderEnum} [order] The order in which to return the results, ordered by timestamp. - * @param {number} [limit] Limit the number of results returned, default is 10 and max is 5000 - * @param {string} [timestampGte] Range by timestamp. - * @param {string} [timestampGt] Range by timestamp. - * @param {string} [timestampLte] Range by timestamp. - * @param {string} [timestampLt] Range by timestamp. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getStocksEMA: async (stockTicker: string, timestamp?: string, timespan?: GetStocksEMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetStocksEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetStocksEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options: RawAxiosRequestConfig = {}): Promise => { - // verify required parameter 'stockTicker' is not null or undefined - assertParamExists('getStocksEMA', 'stockTicker', stockTicker) - const localVarPath = `/v1/indicators/ema/{stockTicker}` - .replace(`{${"stockTicker"}}`, encodeURIComponent(String(stockTicker))); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; + if (evToEbitdaGte !== undefined) { + localVarQueryParameter['ev_to_ebitda.gte'] = evToEbitdaGte; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; + if (evToEbitdaLt !== undefined) { + localVarQueryParameter['ev_to_ebitda.lt'] = evToEbitdaLt; + } - // authentication apiKey required - await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + if (evToEbitdaLte !== undefined) { + localVarQueryParameter['ev_to_ebitda.lte'] = evToEbitdaLte; + } - if (timestamp !== undefined) { - localVarQueryParameter['timestamp'] = timestamp; + if (enterpriseValue !== undefined) { + localVarQueryParameter['enterprise_value'] = enterpriseValue; } - if (timespan !== undefined) { - localVarQueryParameter['timespan'] = timespan; + if (enterpriseValueGt !== undefined) { + localVarQueryParameter['enterprise_value.gt'] = enterpriseValueGt; } - if (adjusted !== undefined) { - localVarQueryParameter['adjusted'] = adjusted; + if (enterpriseValueGte !== undefined) { + localVarQueryParameter['enterprise_value.gte'] = enterpriseValueGte; } - if (window !== undefined) { - localVarQueryParameter['window'] = window; + if (enterpriseValueLt !== undefined) { + localVarQueryParameter['enterprise_value.lt'] = enterpriseValueLt; } - if (seriesType !== undefined) { - localVarQueryParameter['series_type'] = seriesType; + if (enterpriseValueLte !== undefined) { + localVarQueryParameter['enterprise_value.lte'] = enterpriseValueLte; } - if (expandUnderlying !== undefined) { - localVarQueryParameter['expand_underlying'] = expandUnderlying; + if (freeCashFlow !== undefined) { + localVarQueryParameter['free_cash_flow'] = freeCashFlow; } - if (order !== undefined) { - localVarQueryParameter['order'] = order; + if (freeCashFlowGt !== undefined) { + localVarQueryParameter['free_cash_flow.gt'] = freeCashFlowGt; } - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; + if (freeCashFlowGte !== undefined) { + localVarQueryParameter['free_cash_flow.gte'] = freeCashFlowGte; } - if (timestampGte !== undefined) { - localVarQueryParameter['timestamp.gte'] = timestampGte; + if (freeCashFlowLt !== undefined) { + localVarQueryParameter['free_cash_flow.lt'] = freeCashFlowLt; } - if (timestampGt !== undefined) { - localVarQueryParameter['timestamp.gt'] = timestampGt; + if (freeCashFlowLte !== undefined) { + localVarQueryParameter['free_cash_flow.lte'] = freeCashFlowLte; } - if (timestampLte !== undefined) { - localVarQueryParameter['timestamp.lte'] = timestampLte; + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; } - if (timestampLt !== undefined) { - localVarQueryParameter['timestamp.lt'] = timestampLt; + if (sort !== undefined) { + localVarQueryParameter['sort'] = sort; } @@ -20148,7 +26652,44 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * + * US stock exchanges, trading venues, and reporting facilities including exchanges (NYSE, Nasdaq), Trade Reporting Facilities (TRF), Securities Information Processors (SIP), and OTC Reporting Facilities (ORF) for equity trading. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'999\'. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getStocksV1Exchanges: async (limit?: number, options: RawAxiosRequestConfig = {}): Promise => { + const localVarPath = `/stocks/v1/exchanges`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication apiKey required + await setApiKeyToObject(localVarQueryParameter, "apiKey", configuration) + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Comprehensive FINRA short interest data that tracks the short selling metrics for securities on a specific settlement date. * @param {string} [ticker] The primary ticker symbol for the stock. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. @@ -20310,7 +26851,7 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * + * Contains short selling volume for different stock tickers, capturing total trading volume, short sale details, and breakdown by different trading platforms. * @param {string} [ticker] The primary ticker symbol for the stock. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. @@ -20472,7 +27013,7 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Get a single ticker supported by Polygon.io. This response will have detailed information about the ticker and the company behind it. + * Get a single ticker supported by Massive.com. This response will have detailed information about the ticker and the company behind it. * @summary Ticker Details v3 * @param {string} ticker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} [date] Specify a point in time to get information about the ticker available on that date. When retrieving information from SEC filings, we compare this date with the period of report date on the SEC filing. For example, consider an SEC filing submitted by AAPL on 2019-07-31, with a period of report date ending on 2019-06-29. That means that the filing was submitted on 2019-07-31, but the filing was created based on information from 2019-06-29. If you were to query for AAPL details on 2019-06-29, the ticker details would include information from the SEC filing. Defaults to the most recent available date. @@ -20516,7 +27057,7 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * + * Contains corporate events and announcements for publicly traded companies, including earnings releases, conferences, dividends, and business updates sourced from TMX. * @param {string} [date] Scheduled date of the corporate event, formatted as YYYY-MM-DD. * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. @@ -20554,7 +27095,6 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati * @param {string} [tradingVenueLt] Filter less than the value. * @param {string} [tradingVenueLte] Filter less than or equal to the value. * @param {number} [tmxCompanyId] Unique numeric identifier for the company used by TMX. Value must be an integer. - * @param {string} [tmxCompanyIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [tmxCompanyIdGt] Filter greater than the value. Value must be an integer. * @param {number} [tmxCompanyIdGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [tmxCompanyIdLt] Filter less than the value. Value must be an integer. @@ -20570,7 +27110,7 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getTmxV1CorporateEvents: async (date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, type?: string, typeAnyOf?: string, typeGt?: string, typeGte?: string, typeLt?: string, typeLte?: string, status?: string, statusAnyOf?: string, statusGt?: string, statusGte?: string, statusLt?: string, statusLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, isin?: string, isinAnyOf?: string, isinGt?: string, isinGte?: string, isinLt?: string, isinLte?: string, tradingVenue?: string, tradingVenueAnyOf?: string, tradingVenueGt?: string, tradingVenueGte?: string, tradingVenueLt?: string, tradingVenueLte?: string, tmxCompanyId?: number, tmxCompanyIdAnyOf?: string, tmxCompanyIdGt?: number, tmxCompanyIdGte?: number, tmxCompanyIdLt?: number, tmxCompanyIdLte?: number, tmxRecordId?: string, tmxRecordIdAnyOf?: string, tmxRecordIdGt?: string, tmxRecordIdGte?: string, tmxRecordIdLt?: string, tmxRecordIdLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { + getTmxV1CorporateEvents: async (date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, type?: string, typeAnyOf?: string, typeGt?: string, typeGte?: string, typeLt?: string, typeLte?: string, status?: string, statusAnyOf?: string, statusGt?: string, statusGte?: string, statusLt?: string, statusLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, isin?: string, isinAnyOf?: string, isinGt?: string, isinGte?: string, isinLt?: string, isinLte?: string, tradingVenue?: string, tradingVenueAnyOf?: string, tradingVenueGt?: string, tradingVenueGte?: string, tradingVenueLt?: string, tradingVenueLte?: string, tmxCompanyId?: number, tmxCompanyIdGt?: number, tmxCompanyIdGte?: number, tmxCompanyIdLt?: number, tmxCompanyIdLte?: number, tmxRecordId?: string, tmxRecordIdAnyOf?: string, tmxRecordIdGt?: string, tmxRecordIdGte?: string, tmxRecordIdLt?: string, tmxRecordIdLte?: string, limit?: number, sort?: string, options: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/tmx/v1/corporate-events`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -20734,10 +27274,6 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['tmx_company_id'] = tmxCompanyId; } - if (tmxCompanyIdAnyOf !== undefined) { - localVarQueryParameter['tmx_company_id.any_of'] = tmxCompanyIdAnyOf; - } - if (tmxCompanyIdGt !== undefined) { localVarQueryParameter['tmx_company_id.gt'] = tmxCompanyIdGt; } @@ -20798,7 +27334,7 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * List all conditions that Polygon.io uses. + * List all conditions that Massive.com uses. * @summary Conditions * @param {ListConditionsAssetClassEnum} [assetClass] Filter for conditions within a given asset class. * @param {ListConditionsDataTypeEnum} [dataType] Filter by data type. @@ -21114,7 +27650,7 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * List all exchanges that Polygon.io knows about. + * List all exchanges that Massive.com knows about. * @summary Exchanges * @param {ListExchangesAssetClassEnum} [assetClass] Filter by asset class. * @param {ListExchangesLocaleEnum} [locale] Filter by locale. @@ -21524,7 +28060,7 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati * Query for historical options contracts. This provides both active and expired options contracts. * @summary Options Contracts * @param {string} [underlyingTicker] Query for contracts relating to an underlying stock ticker. - * @param {string} [ticker] This parameter has been deprecated. To search by specific options ticker, use the Options Contract endpoint [here](https://polygon.io/docs/options/get_v3_reference_options_contracts__options_ticker). + * @param {string} [ticker] This parameter has been deprecated. To search by specific options ticker, use the Options Contract endpoint [here](https://massive.com/docs/options/get_v3_reference_options_contracts__options_ticker). * @param {ListOptionsContractsContractTypeEnum} [contractType] Query by the type of contract. * @param {string} [expirationDate] Query by contract expiration with date format YYYY-MM-DD. * @param {string} [asOf] Specify a point in time for contracts as of this date with format YYYY-MM-DD. Defaults to today\'s date. @@ -21777,7 +28313,7 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * List all ticker types that Polygon.io has. + * List all ticker types that Massive.com has. * @summary Ticker Types * @param {ListTickerTypesAssetClassEnum} [assetClass] Filter by asset class. * @param {ListTickerTypesLocaleEnum} [locale] Filter by locale. @@ -21820,10 +28356,10 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * Query all ticker symbols which are supported by Polygon.io. This API currently includes Stocks/Equities, Indices, Forex, and Crypto. + * Query all ticker symbols which are supported by Massive.com. This API currently includes Stocks/Equities, Indices, Forex, and Crypto. * @summary Tickers * @param {string} [ticker] Specify a ticker symbol. Defaults to empty string which queries all tickers. - * @param {ListTickersTypeEnum} [type] Specify the type of the tickers. Find the types that we support via our [Ticker Types API](https://polygon.io/docs/stocks/get_v3_reference_tickers_types). Defaults to empty string which queries all types. + * @param {ListTickersTypeEnum} [type] Specify the type of the tickers. Find the types that we support via our [Ticker Types API](https://massive.com/docs/stocks/get_v3_reference_tickers_types). Defaults to empty string which queries all types. * @param {ListTickersMarketEnum} [market] Filter by market type. By default all markets are included. * @param {string} [exchange] Specify the asset\'s primary exchange Market Identifier Code (MIC) according to [ISO 10383](https://www.iso20022.org/market-identifier-codes). Defaults to empty string which queries all exchanges. * @param {string} [cusip] Specify the CUSIP code of the asset you want to search for. Find more information about CUSIP codes [at their website](https://www.cusip.com/identifiers.html#/CUSIP). Defaults to empty string which queries all CUSIPs. Note: Although you can query by CUSIP, due to legal reasons we do not return the CUSIP in the response. @@ -22123,6 +28659,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * A comprehensive financial consensus ratings table that aggregates analyst recommendations and price targets for individual stock tickers, capturing detailed rating breakdowns and statistical insights. * @param {string} ticker The requested ticker. * @param {string} [date] The publication date of the news article. + * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. @@ -22131,8 +28668,8 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getBenzingaV1ConsensusRatings(ticker: string, date?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getBenzingaV1ConsensusRatings(ticker, date, dateGt, dateGte, dateLt, dateLte, limit, options); + async getBenzingaV1ConsensusRatings(ticker: string, date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getBenzingaV1ConsensusRatings(ticker, date, dateAnyOf, dateGt, dateGte, dateLt, dateLte, limit, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['DefaultApi.getBenzingaV1ConsensusRatings']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -22157,12 +28694,12 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {number} [importanceGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [importanceLt] Filter less than the value. Value must be an integer. * @param {number} [importanceLte] Filter less than or equal to the value. Value must be an integer. - * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system. - * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [lastUpdatedGt] Filter greater than the value. - * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. - * @param {string} [lastUpdatedLt] Filter less than the value. - * @param {string} [lastUpdatedLte] Filter less than or equal to the value. + * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedGt] Filter greater than the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedLt] Filter less than the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedLte] Filter less than or equal to the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. * @param {string} [dateStatus] Indicates whether the date of the earnings report has been confirmed. Possible values include: projected, confirmed. * @param {string} [dateStatusAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateStatusGt] Filter greater than the value. @@ -22194,7 +28731,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {string} [fiscalPeriodLt] Filter less than the value. * @param {string} [fiscalPeriodLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. - * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'last_updated\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -22333,17 +28870,15 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {number} [importance] A subjective indicator of the importance of the earnings event, on a scale from 0 (lowest) to 5 (highest). Value must be an integer. - * @param {string} [importanceAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [importanceGt] Filter greater than the value. Value must be an integer. * @param {number} [importanceGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [importanceLt] Filter less than the value. Value must be an integer. * @param {number} [importanceLte] Filter less than or equal to the value. Value must be an integer. - * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system. - * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [lastUpdatedGt] Filter greater than the value. - * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. - * @param {string} [lastUpdatedLt] Filter less than the value. - * @param {string} [lastUpdatedLte] Filter less than or equal to the value. + * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedGt] Filter greater than the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedLt] Filter less than the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedLte] Filter less than or equal to the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. * @param {string} [ratingAction] The description of the change in rating from the firm\'s last rating. Possible values include: downgrades, maintains, reinstates, reiterates, upgrades, assumes, initiates_coverage_on, terminates_coverage_on, removes, suspends, firm_dissolved. * @param {string} [ratingActionAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [ratingActionGt] Filter greater than the value. @@ -22375,14 +28910,50 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {string} [benzingaFirmIdLt] Filter less than the value. * @param {string} [benzingaFirmIdLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. - * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'last_updated\' if not specified. The sort order defaults to \'desc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getBenzingaV1Ratings(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, importance?: number, importanceGt?: number, importanceGte?: number, importanceLt?: number, importanceLte?: number, lastUpdated?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, ratingAction?: string, ratingActionAnyOf?: string, ratingActionGt?: string, ratingActionGte?: string, ratingActionLt?: string, ratingActionLte?: string, priceTargetAction?: string, priceTargetActionAnyOf?: string, priceTargetActionGt?: string, priceTargetActionGte?: string, priceTargetActionLt?: string, priceTargetActionLte?: string, benzingaId?: string, benzingaIdAnyOf?: string, benzingaIdGt?: string, benzingaIdGte?: string, benzingaIdLt?: string, benzingaIdLte?: string, benzingaAnalystId?: string, benzingaAnalystIdAnyOf?: string, benzingaAnalystIdGt?: string, benzingaAnalystIdGte?: string, benzingaAnalystIdLt?: string, benzingaAnalystIdLte?: string, benzingaFirmId?: string, benzingaFirmIdAnyOf?: string, benzingaFirmIdGt?: string, benzingaFirmIdGte?: string, benzingaFirmIdLt?: string, benzingaFirmIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getBenzingaV1Ratings(date, dateAnyOf, dateGt, dateGte, dateLt, dateLte, ticker, tickerAnyOf, tickerGt, tickerGte, tickerLt, tickerLte, importance, importanceGt, importanceGte, importanceLt, importanceLte, lastUpdated, lastUpdatedGt, lastUpdatedGte, lastUpdatedLt, lastUpdatedLte, ratingAction, ratingActionAnyOf, ratingActionGt, ratingActionGte, ratingActionLt, ratingActionLte, priceTargetAction, priceTargetActionAnyOf, priceTargetActionGt, priceTargetActionGte, priceTargetActionLt, priceTargetActionLte, benzingaId, benzingaIdAnyOf, benzingaIdGt, benzingaIdGte, benzingaIdLt, benzingaIdLte, benzingaAnalystId, benzingaAnalystIdAnyOf, benzingaAnalystIdGt, benzingaAnalystIdGte, benzingaAnalystIdLt, benzingaAnalystIdLte, benzingaFirmId, benzingaFirmIdAnyOf, benzingaFirmIdGt, benzingaFirmIdGte, benzingaFirmIdLt, benzingaFirmIdLte, limit, sort, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.getBenzingaV1Ratings']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * A comprehensive news article database from Benzinga, containing detailed information about financial news articles including metadata, content, and associated financial information. + * @param {string} [published] The timestamp (formatted as an ISO 8601 timestamp) when the news article was originally published. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [publishedGt] Filter greater than the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [publishedGte] Filter greater than or equal to the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [publishedLt] Filter less than the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [publishedLte] Filter less than or equal to the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [channels] Filter for arrays that contain the value. + * @param {string} [channelsAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [channelsAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tags] Filter for arrays that contain the value. + * @param {string} [tagsAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tagsAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [author] The name of the journalist or entity that authored the news article. + * @param {string} [authorAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [authorGt] Filter greater than the value. + * @param {string} [authorGte] Filter greater than or equal to the value. + * @param {string} [authorLt] Filter less than the value. + * @param {string} [authorLte] Filter less than or equal to the value. + * @param {string} [stocks] Filter for arrays that contain the value. + * @param {string} [stocksAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [stocksAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickers] Filter for arrays that contain the value. + * @param {string} [tickersAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickersAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'published\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getBenzingaV1Ratings(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, importance?: number, importanceAnyOf?: string, importanceGt?: number, importanceGte?: number, importanceLt?: number, importanceLte?: number, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, ratingAction?: string, ratingActionAnyOf?: string, ratingActionGt?: string, ratingActionGte?: string, ratingActionLt?: string, ratingActionLte?: string, priceTargetAction?: string, priceTargetActionAnyOf?: string, priceTargetActionGt?: string, priceTargetActionGte?: string, priceTargetActionLt?: string, priceTargetActionLte?: string, benzingaId?: string, benzingaIdAnyOf?: string, benzingaIdGt?: string, benzingaIdGte?: string, benzingaIdLt?: string, benzingaIdLte?: string, benzingaAnalystId?: string, benzingaAnalystIdAnyOf?: string, benzingaAnalystIdGt?: string, benzingaAnalystIdGte?: string, benzingaAnalystIdLt?: string, benzingaAnalystIdLte?: string, benzingaFirmId?: string, benzingaFirmIdAnyOf?: string, benzingaFirmIdGt?: string, benzingaFirmIdGte?: string, benzingaFirmIdLt?: string, benzingaFirmIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getBenzingaV1Ratings(date, dateAnyOf, dateGt, dateGte, dateLt, dateLte, ticker, tickerAnyOf, tickerGt, tickerGte, tickerLt, tickerLte, importance, importanceAnyOf, importanceGt, importanceGte, importanceLt, importanceLte, lastUpdated, lastUpdatedAnyOf, lastUpdatedGt, lastUpdatedGte, lastUpdatedLt, lastUpdatedLte, ratingAction, ratingActionAnyOf, ratingActionGt, ratingActionGte, ratingActionLt, ratingActionLte, priceTargetAction, priceTargetActionAnyOf, priceTargetActionGt, priceTargetActionGte, priceTargetActionLt, priceTargetActionLte, benzingaId, benzingaIdAnyOf, benzingaIdGt, benzingaIdGte, benzingaIdLt, benzingaIdLte, benzingaAnalystId, benzingaAnalystIdAnyOf, benzingaAnalystIdGt, benzingaAnalystIdGte, benzingaAnalystIdLt, benzingaAnalystIdLte, benzingaFirmId, benzingaFirmIdAnyOf, benzingaFirmIdGt, benzingaFirmIdGte, benzingaFirmIdLt, benzingaFirmIdLte, limit, sort, options); + async getBenzingaV2News(published?: string, publishedGt?: string, publishedGte?: string, publishedLt?: string, publishedLte?: string, channels?: string, channelsAllOf?: string, channelsAnyOf?: string, tags?: string, tagsAllOf?: string, tagsAnyOf?: string, author?: string, authorAnyOf?: string, authorGt?: string, authorGte?: string, authorLt?: string, authorLte?: string, stocks?: string, stocksAllOf?: string, stocksAnyOf?: string, tickers?: string, tickersAllOf?: string, tickersAnyOf?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getBenzingaV2News(published, publishedGt, publishedGte, publishedLt, publishedLte, channels, channelsAllOf, channelsAnyOf, tags, tagsAllOf, tagsAnyOf, author, authorAnyOf, authorGt, authorGte, authorLt, authorLte, stocks, stocksAllOf, stocksAnyOf, tickers, tickersAllOf, tickersAnyOf, limit, sort, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; - const localVarOperationServerBasePath = operationServerMap['DefaultApi.getBenzingaV1Ratings']?.[localVarOperationServerIndex]?.url; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.getBenzingaV2News']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** @@ -22395,7 +28966,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetCryptoAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). - * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. + * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://massive.com/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -22579,6 +29150,18 @@ export const DefaultApiFp = function(configuration?: Configuration) { const localVarOperationServerBasePath = operationServerMap['DefaultApi.getCryptoTrades']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * Global cryptocurrency exchanges and digital asset trading platforms, including major centralized exchanges (Coinbase, Binance, Bitfinex, etc.) that facilitate trading of cryptocurrencies and digital tokens worldwide. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'999\'. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getCryptoV1Exchanges(limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getCryptoV1Exchanges(limit, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.getCryptoV1Exchanges']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, /** * Get currency conversions using the latest market conversion rates. Note than you can convert in both directions. For example USD to CAD or CAD to USD. * @summary Real-time Currency Conversion @@ -22595,10 +29178,236 @@ export const DefaultApiFp = function(configuration?: Configuration) { const localVarOperationServerBasePath = operationServerMap['DefaultApi.getCurrencyConversion']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * ETF Global analytics data containing risk scores, reward metrics, and quantitative analysis for ETF composite tickers. + * @param {string} [compositeTicker] The stock ticker symbol used to identify this ETF product on exchanges. + * @param {string} [compositeTickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [compositeTickerGt] Filter greater than the value. + * @param {string} [compositeTickerGte] Filter greater than or equal to the value. + * @param {string} [compositeTickerLt] Filter less than the value. + * @param {string} [compositeTickerLte] Filter less than or equal to the value. + * @param {string} [processedDate] The date showing when ETF Global received and processed the data. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDate] The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {number} [riskTotalScore] ETF Global\'s proprietary Red Diamond overall risk assessment score for the ETF. Value must be a floating point number. + * @param {number} [riskTotalScoreGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [riskTotalScoreGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [riskTotalScoreLt] Filter less than the value. Value must be a floating point number. + * @param {number} [riskTotalScoreLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [rewardScore] ETF Global\'s proprietary Green Diamond score measuring the potential reward and return prospects of the ETF. Value must be a floating point number. + * @param {number} [rewardScoreGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [rewardScoreGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [rewardScoreLt] Filter less than the value. Value must be a floating point number. + * @param {number} [rewardScoreLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quantTotalScore] ETF Global\'s comprehensive quantitative analysis score combining all quantitative factors. Value must be a floating point number. + * @param {number} [quantTotalScoreGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantTotalScoreGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantTotalScoreLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantTotalScoreLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {string} [quantGrade] Letter grade summarizing the ETF\'s overall quantitative assessment, where A = 71-100, B = 56-70, etc. + * @param {string} [quantGradeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [quantGradeGt] Filter greater than the value. + * @param {string} [quantGradeGte] Filter greater than or equal to the value. + * @param {string} [quantGradeLt] Filter less than the value. + * @param {string} [quantGradeLte] Filter less than or equal to the value. + * @param {number} [quantCompositeTechnical] Combined technical analysis score aggregating short, intermediate, and long-term technical factors. Value must be a floating point number. + * @param {number} [quantCompositeTechnicalGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantCompositeTechnicalGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeTechnicalLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantCompositeTechnicalLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeSentiment] Overall market sentiment score combining put/call ratios, short interest, and implied volatility. Value must be a floating point number. + * @param {number} [quantCompositeSentimentGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantCompositeSentimentGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeSentimentLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantCompositeSentimentLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeBehavioral] Behavioral analysis score measuring investor psychology and market behavior patterns. Value must be a floating point number. + * @param {number} [quantCompositeBehavioralGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantCompositeBehavioralGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeBehavioralLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantCompositeBehavioralLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeFundamental] Overall fundamental analysis score combining P/E, P/CF, P/B, and dividend yield metrics. Value must be a floating point number. + * @param {number} [quantCompositeFundamentalGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantCompositeFundamentalGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeFundamentalLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantCompositeFundamentalLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeGlobal] Overall global theme score combining sector and country analysis for macro investment views. Value must be a floating point number. + * @param {number} [quantCompositeGlobalGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantCompositeGlobalGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeGlobalLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantCompositeGlobalLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeQuality] Overall quality assessment score combining liquidity, diversification, and issuing firm factors. Value must be a floating point number. + * @param {number} [quantCompositeQualityGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantCompositeQualityGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeQualityLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantCompositeQualityLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'5000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'composite_ticker\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getEtfGlobalV1Analytics(compositeTicker?: string, compositeTickerAnyOf?: string, compositeTickerGt?: string, compositeTickerGte?: string, compositeTickerLt?: string, compositeTickerLte?: string, processedDate?: string, processedDateGt?: string, processedDateGte?: string, processedDateLt?: string, processedDateLte?: string, effectiveDate?: string, effectiveDateGt?: string, effectiveDateGte?: string, effectiveDateLt?: string, effectiveDateLte?: string, riskTotalScore?: number, riskTotalScoreGt?: number, riskTotalScoreGte?: number, riskTotalScoreLt?: number, riskTotalScoreLte?: number, rewardScore?: number, rewardScoreGt?: number, rewardScoreGte?: number, rewardScoreLt?: number, rewardScoreLte?: number, quantTotalScore?: number, quantTotalScoreGt?: number, quantTotalScoreGte?: number, quantTotalScoreLt?: number, quantTotalScoreLte?: number, quantGrade?: string, quantGradeAnyOf?: string, quantGradeGt?: string, quantGradeGte?: string, quantGradeLt?: string, quantGradeLte?: string, quantCompositeTechnical?: number, quantCompositeTechnicalGt?: number, quantCompositeTechnicalGte?: number, quantCompositeTechnicalLt?: number, quantCompositeTechnicalLte?: number, quantCompositeSentiment?: number, quantCompositeSentimentGt?: number, quantCompositeSentimentGte?: number, quantCompositeSentimentLt?: number, quantCompositeSentimentLte?: number, quantCompositeBehavioral?: number, quantCompositeBehavioralGt?: number, quantCompositeBehavioralGte?: number, quantCompositeBehavioralLt?: number, quantCompositeBehavioralLte?: number, quantCompositeFundamental?: number, quantCompositeFundamentalGt?: number, quantCompositeFundamentalGte?: number, quantCompositeFundamentalLt?: number, quantCompositeFundamentalLte?: number, quantCompositeGlobal?: number, quantCompositeGlobalGt?: number, quantCompositeGlobalGte?: number, quantCompositeGlobalLt?: number, quantCompositeGlobalLte?: number, quantCompositeQuality?: number, quantCompositeQualityGt?: number, quantCompositeQualityGte?: number, quantCompositeQualityLt?: number, quantCompositeQualityLte?: number, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getEtfGlobalV1Analytics(compositeTicker, compositeTickerAnyOf, compositeTickerGt, compositeTickerGte, compositeTickerLt, compositeTickerLte, processedDate, processedDateGt, processedDateGte, processedDateLt, processedDateLte, effectiveDate, effectiveDateGt, effectiveDateGte, effectiveDateLt, effectiveDateLte, riskTotalScore, riskTotalScoreGt, riskTotalScoreGte, riskTotalScoreLt, riskTotalScoreLte, rewardScore, rewardScoreGt, rewardScoreGte, rewardScoreLt, rewardScoreLte, quantTotalScore, quantTotalScoreGt, quantTotalScoreGte, quantTotalScoreLt, quantTotalScoreLte, quantGrade, quantGradeAnyOf, quantGradeGt, quantGradeGte, quantGradeLt, quantGradeLte, quantCompositeTechnical, quantCompositeTechnicalGt, quantCompositeTechnicalGte, quantCompositeTechnicalLt, quantCompositeTechnicalLte, quantCompositeSentiment, quantCompositeSentimentGt, quantCompositeSentimentGte, quantCompositeSentimentLt, quantCompositeSentimentLte, quantCompositeBehavioral, quantCompositeBehavioralGt, quantCompositeBehavioralGte, quantCompositeBehavioralLt, quantCompositeBehavioralLte, quantCompositeFundamental, quantCompositeFundamentalGt, quantCompositeFundamentalGte, quantCompositeFundamentalLt, quantCompositeFundamentalLte, quantCompositeGlobal, quantCompositeGlobalGt, quantCompositeGlobalGte, quantCompositeGlobalLt, quantCompositeGlobalLte, quantCompositeQuality, quantCompositeQualityGt, quantCompositeQualityGte, quantCompositeQualityLt, quantCompositeQualityLte, limit, sort, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.getEtfGlobalV1Analytics']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * ETF Global constituents data containing detailed information about the securities held within ETFs, including weights, market values, and security identifiers. + * @param {string} [compositeTicker] The stock ticker symbol of the ETF that holds these constituent securities. + * @param {string} [compositeTickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [compositeTickerGt] Filter greater than the value. + * @param {string} [compositeTickerGte] Filter greater than or equal to the value. + * @param {string} [compositeTickerLt] Filter less than the value. + * @param {string} [compositeTickerLte] Filter less than or equal to the value. + * @param {string} [constituentTicker] The stock ticker symbol of the individual security held within the ETF. + * @param {string} [constituentTickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [constituentTickerGt] Filter greater than the value. + * @param {string} [constituentTickerGte] Filter greater than or equal to the value. + * @param {string} [constituentTickerLt] Filter less than the value. + * @param {string} [constituentTickerLte] Filter less than or equal to the value. + * @param {string} [effectiveDate] The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDate] The date showing when ETF Global received and processed the data. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [usCode] A unique identifier code for the constituent security in US markets. + * @param {string} [usCodeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [usCodeGt] Filter greater than the value. + * @param {string} [usCodeGte] Filter greater than or equal to the value. + * @param {string} [usCodeLt] Filter less than the value. + * @param {string} [usCodeLte] Filter less than or equal to the value. + * @param {string} [isin] The International Securities Identification Number, a global standard for identifying securities. + * @param {string} [isinAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [isinGt] Filter greater than the value. + * @param {string} [isinGte] Filter greater than or equal to the value. + * @param {string} [isinLt] Filter less than the value. + * @param {string} [isinLte] Filter less than or equal to the value. + * @param {string} [figi] The Financial Instrument Global Identifier, an open standard for uniquely identifying financial instruments. + * @param {string} [figiAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [figiGt] Filter greater than the value. + * @param {string} [figiGte] Filter greater than or equal to the value. + * @param {string} [figiLt] Filter less than the value. + * @param {string} [figiLte] Filter less than or equal to the value. + * @param {string} [sedol] The Stock Exchange Daily Official List code, primarily used for securities trading in the UK. + * @param {string} [sedolAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [sedolGt] Filter greater than the value. + * @param {string} [sedolGte] Filter greater than or equal to the value. + * @param {string} [sedolLt] Filter less than the value. + * @param {string} [sedolLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'5000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'composite_ticker\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getEtfGlobalV1Constituents(compositeTicker?: string, compositeTickerAnyOf?: string, compositeTickerGt?: string, compositeTickerGte?: string, compositeTickerLt?: string, compositeTickerLte?: string, constituentTicker?: string, constituentTickerAnyOf?: string, constituentTickerGt?: string, constituentTickerGte?: string, constituentTickerLt?: string, constituentTickerLte?: string, effectiveDate?: string, effectiveDateGt?: string, effectiveDateGte?: string, effectiveDateLt?: string, effectiveDateLte?: string, processedDate?: string, processedDateGt?: string, processedDateGte?: string, processedDateLt?: string, processedDateLte?: string, usCode?: string, usCodeAnyOf?: string, usCodeGt?: string, usCodeGte?: string, usCodeLt?: string, usCodeLte?: string, isin?: string, isinAnyOf?: string, isinGt?: string, isinGte?: string, isinLt?: string, isinLte?: string, figi?: string, figiAnyOf?: string, figiGt?: string, figiGte?: string, figiLt?: string, figiLte?: string, sedol?: string, sedolAnyOf?: string, sedolGt?: string, sedolGte?: string, sedolLt?: string, sedolLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getEtfGlobalV1Constituents(compositeTicker, compositeTickerAnyOf, compositeTickerGt, compositeTickerGte, compositeTickerLt, compositeTickerLte, constituentTicker, constituentTickerAnyOf, constituentTickerGt, constituentTickerGte, constituentTickerLt, constituentTickerLte, effectiveDate, effectiveDateGt, effectiveDateGte, effectiveDateLt, effectiveDateLte, processedDate, processedDateGt, processedDateGte, processedDateLt, processedDateLte, usCode, usCodeAnyOf, usCodeGt, usCodeGte, usCodeLt, usCodeLte, isin, isinAnyOf, isinGt, isinGte, isinLt, isinLte, figi, figiAnyOf, figiGt, figiGte, figiLt, figiLte, sedol, sedolAnyOf, sedolGt, sedolGte, sedolLt, sedolLte, limit, sort, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.getEtfGlobalV1Constituents']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * ETF Global fund flow data containing information about ETF share movements, net asset values, and fund flow metrics. + * @param {string} [processedDate] The date showing when ETF Global received and processed the data. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDate] The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [compositeTicker] The stock ticker symbol used to identify this ETF on exchanges. + * @param {string} [compositeTickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [compositeTickerGt] Filter greater than the value. + * @param {string} [compositeTickerGte] Filter greater than or equal to the value. + * @param {string} [compositeTickerLt] Filter less than the value. + * @param {string} [compositeTickerLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'5000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'composite_ticker\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getEtfGlobalV1FundFlows(processedDate?: string, processedDateGt?: string, processedDateGte?: string, processedDateLt?: string, processedDateLte?: string, effectiveDate?: string, effectiveDateGt?: string, effectiveDateGte?: string, effectiveDateLt?: string, effectiveDateLte?: string, compositeTicker?: string, compositeTickerAnyOf?: string, compositeTickerGt?: string, compositeTickerGte?: string, compositeTickerLt?: string, compositeTickerLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getEtfGlobalV1FundFlows(processedDate, processedDateGt, processedDateGte, processedDateLt, processedDateLte, effectiveDate, effectiveDateGt, effectiveDateGte, effectiveDateLt, effectiveDateLte, compositeTicker, compositeTickerAnyOf, compositeTickerGt, compositeTickerGte, compositeTickerLt, compositeTickerLte, limit, sort, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.getEtfGlobalV1FundFlows']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * ETF Global industry profile data containing comprehensive ETF metadata including financial metrics, operational details, and exposure information. + * @param {string} [processedDate] The date showing when ETF Global received and processed the data. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDate] The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [compositeTicker] The stock ticker symbol used to identify this ETF product on exchanges. + * @param {string} [compositeTickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [compositeTickerGt] Filter greater than the value. + * @param {string} [compositeTickerGte] Filter greater than or equal to the value. + * @param {string} [compositeTickerLt] Filter less than the value. + * @param {string} [compositeTickerLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'5000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'composite_ticker\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getEtfGlobalV1Profiles(processedDate?: string, processedDateGt?: string, processedDateGte?: string, processedDateLt?: string, processedDateLte?: string, effectiveDate?: string, effectiveDateGt?: string, effectiveDateGte?: string, effectiveDateLt?: string, effectiveDateLte?: string, compositeTicker?: string, compositeTickerAnyOf?: string, compositeTickerGt?: string, compositeTickerGte?: string, compositeTickerLt?: string, compositeTickerLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getEtfGlobalV1Profiles(processedDate, processedDateGt, processedDateGte, processedDateLt, processedDateLte, effectiveDate, effectiveDateGt, effectiveDateGte, effectiveDateLt, effectiveDateLte, compositeTicker, compositeTickerAnyOf, compositeTickerGt, compositeTickerGte, compositeTickerLt, compositeTickerLte, limit, sort, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.getEtfGlobalV1Profiles']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * ETF Global taxonomy data containing detailed classification and categorization information for ETFs including investment strategy, methodology, and structural characteristics. + * @param {string} [processedDate] The date showing when ETF Global received and processed the data. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDate] The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [compositeTicker] The stock ticker symbol used to identify this ETF product on exchanges. + * @param {string} [compositeTickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [compositeTickerGt] Filter greater than the value. + * @param {string} [compositeTickerGte] Filter greater than or equal to the value. + * @param {string} [compositeTickerLt] Filter less than the value. + * @param {string} [compositeTickerLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'5000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'composite_ticker\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getEtfGlobalV1Taxonomies(processedDate?: string, processedDateGt?: string, processedDateGte?: string, processedDateLt?: string, processedDateLte?: string, effectiveDate?: string, effectiveDateGt?: string, effectiveDateGte?: string, effectiveDateLt?: string, effectiveDateLte?: string, compositeTicker?: string, compositeTickerAnyOf?: string, compositeTickerGt?: string, compositeTickerGte?: string, compositeTickerLt?: string, compositeTickerLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getEtfGlobalV1Taxonomies(processedDate, processedDateGt, processedDateGte, processedDateLt, processedDateLte, effectiveDate, effectiveDateGt, effectiveDateGte, effectiveDateLt, effectiveDateLte, compositeTicker, compositeTickerAnyOf, compositeTickerGt, compositeTickerGte, compositeTickerLt, compositeTickerLte, limit, sort, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.getEtfGlobalV1Taxonomies']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, /** * Get a timeline of events for the entity associated with the given ticker, CUSIP, or Composite FIGI. * @summary Ticker Events - * @param {string} id Identifier of an asset, which can be a Ticker, CUSIP, or Composite FIGI. Specify a case-sensitive ticker symbol (e.g. AAPL for Apple Inc). When provided a ticker, events for the entity currently represented by that ticker are returned. To find events for entities previously associated with a ticker, obtain the relevant identifier using the [Ticker Details Endpoint](https://polygon.io/docs/stocks/get_v3_reference_tickers__ticker). + * @param {string} id Identifier of an asset, which can be a Ticker, CUSIP, or Composite FIGI. Specify a case-sensitive ticker symbol (e.g. AAPL for Apple Inc). When provided a ticker, events for the entity currently represented by that ticker are returned. To find events for entities previously associated with a ticker, obtain the relevant identifier using the [Ticker Details Endpoint](https://massive.com/docs/stocks/get_v3_reference_tickers__ticker). * @param {string} [types] A comma-separated list of the types of event to include. Currently ticker_change is the only supported event_type. Leave blank to return all supported event_types. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -22676,7 +29485,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetForexAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). - * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. + * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://massive.com/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -22848,12 +29657,24 @@ export const DefaultApiFp = function(configuration?: Configuration) { const localVarOperationServerBasePath = operationServerMap['DefaultApi.getForexSnapshotTickers']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * Global foreign exchange (FX) trading venues and market infrastructure, including electronic trading platforms, banks, and other institutions facilitating currency pair trading worldwide. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'999\'. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getForexV1Exchanges(limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getForexV1Exchanges(limit, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.getForexV1Exchanges']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, /** * Get aggregates for a contract in a given time range. * @summary Aggregates * @param {string} ticker The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract). * @param {string} [resolution] This sets the size of the aggregate windows. It accepts custom values that specify the granularity and the duration of the window. For example: 15mins, 30secs, 12hours, or 7days. There are maximum allowable candle sizes. For example, you can request \"1min\" to \"59mins\", but after that you will need to use \"1hr\". If you make a request for a candle size that is not supported, we will return a 400 \"Bad Request - resolution value is not allowed.\" - * @param {string} [windowStart] This sets the range of time for your results. The window_start timestamp you choose specifies the starting edge of the candle or candles you want returned. If no value is set, you will get the oldest or newest available candles, depending on your sort order. You can combine window_start to form a time range, for example: window_start.gte=2024-01-01&window_start.lte=2024-01-31 + * @param {string} [windowStart] Specifies the start time of the aggregate (OHLC) candles you want returned (YYYY-MM-DD date or nanosecond Unix timestamp). How it works - If not provided, the API returns the most recent candles available, up to the limit you set. - If provided, the value determines which candle(s) to return. The timestamp or date is “snapped” to the start time of the matching candle interval. - You can use comparison operators to form ranges: - `window_start.gte` – greater than or equal to - `window_start.gt` – greater than - `window_start.lte` – less than or equal to - `window_start.lt` – less than Examples 1. Most recent minute candles `/vX/aggs/ESU5?resolution=1min&limit=5` 2. Daily candle for August 5, 2025 `/vX/aggs/ESU5?resolution=1day&window_start=2025-08-05` 3. Daily candles from July 1–31, 2025 `/vX/aggs/ESU5?resolution=1day&window_start.gte=2025-07-01&window_start.lte=2025-07-31` 4. 1,000 one-second candles after a specific timestamp `/vX/aggs/ESU5?resolution=1sec&window_start.gt=1751409877000000000&limit=1000` * @param {number} [limit] The number of results to return per page (default=1000, maximum=50000, minimum=1). * @param {string} [windowStartGte] Range by window_start. * @param {string} [windowStartGt] Range by window_start. @@ -23043,6 +29864,153 @@ export const DefaultApiFp = function(configuration?: Configuration) { const localVarOperationServerBasePath = operationServerMap['DefaultApi.getFuturesTrades']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * Retrieve detailed information about a specific futures contract identified by its ticker. The response includes comprehensive attributes such as active status, trade dates, days to maturity, exchange code, order quantity limits, settlement date, tick sizes, and other key metrics. Users can specify a point-in-time (as_of) to view the contract\'s state on a particular date, supporting informed trading decisions and historical analysis. Use Cases: Contract specification, historical product checks, system integration, trading decision support. + * @summary futures_contracts_v1 API + * @param {string} [date] A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about products for the specified day (default=today). Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [productCode] The unique identifier for the product. + * @param {string} [productCodeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [productCodeGt] Filter greater than the value. + * @param {string} [productCodeGte] Filter greater than or equal to the value. + * @param {string} [productCodeLt] Filter less than the value. + * @param {string} [productCodeLte] Filter less than or equal to the value. + * @param {string} [ticker] The ticker for the contract. + * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickerGt] Filter greater than the value. + * @param {string} [tickerGte] Filter greater than or equal to the value. + * @param {string} [tickerLt] Filter less than the value. + * @param {string} [tickerLte] Filter less than or equal to the value. + * @param {string} [active] The contract is still trading. Value must be \'true\', \'false\', \'1\' or \'0\'. + * @param {string} [type] The type of product, one of \'single\' or \'combo\'. + * @param {string} [typeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [typeGt] Filter greater than the value. + * @param {string} [typeGte] Filter greater than or equal to the value. + * @param {string} [typeLt] Filter less than the value. + * @param {string} [typeLte] Filter less than or equal to the value. + * @param {string} [firstTradeDate] The first date the contract trades. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [firstTradeDateGt] Filter greater than the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [firstTradeDateGte] Filter greater than or equal to the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [firstTradeDateLt] Filter less than the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [firstTradeDateLte] Filter less than or equal to the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastTradeDate] The last date the contract trades. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastTradeDateGt] Filter greater than the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastTradeDateGte] Filter greater than or equal to the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastTradeDateLt] Filter less than the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastTradeDateLte] Filter less than or equal to the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'1000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'product_code\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getFuturesVXContractsNew(date?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, productCode?: string, productCodeAnyOf?: string, productCodeGt?: string, productCodeGte?: string, productCodeLt?: string, productCodeLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, active?: string, type?: string, typeAnyOf?: string, typeGt?: string, typeGte?: string, typeLt?: string, typeLte?: string, firstTradeDate?: string, firstTradeDateGt?: string, firstTradeDateGte?: string, firstTradeDateLt?: string, firstTradeDateLte?: string, lastTradeDate?: string, lastTradeDateGt?: string, lastTradeDateGte?: string, lastTradeDateLt?: string, lastTradeDateLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getFuturesVXContractsNew(date, dateGt, dateGte, dateLt, dateLte, productCode, productCodeAnyOf, productCodeGt, productCodeGte, productCodeLt, productCodeLte, ticker, tickerAnyOf, tickerGt, tickerGte, tickerLt, tickerLte, active, type, typeAnyOf, typeGt, typeGte, typeLt, typeLte, firstTradeDate, firstTradeDateGt, firstTradeDateGte, firstTradeDateLt, firstTradeDateLte, lastTradeDate, lastTradeDateGt, lastTradeDateGte, lastTradeDateLt, lastTradeDateLte, limit, sort, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.getFuturesVXContractsNew']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * US futures exchanges and trading venues including major derivatives exchanges (CME, CBOT, NYMEX, COMEX) and other futures market infrastructure for commodity, financial, and other derivative contract trading. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'999\'. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getFuturesVXExchanges(limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getFuturesVXExchanges(limit, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.getFuturesVXExchanges']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Retrieve detailed information about a single futures product as of a specified date, including its asset class, exchange code, full product name, settlement details, pricing quotation, sector classifications, and unit of measure. Optional parameters such as product type (single or combo) and as_of allow you to capture the product’s state on a specific day, providing essential context for trading decisions and system integrations. Use Cases: Product specification, historical product checks, risk management, trading system integration. + * @summary futures_products_v1 API + * @param {string} [name] The full name of the product. + * @param {string} [nameAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [nameGt] Filter greater than the value. + * @param {string} [nameGte] Filter greater than or equal to the value. + * @param {string} [nameLt] Filter less than the value. + * @param {string} [nameLte] Filter less than or equal to the value. + * @param {string} [productCode] The unique identifier for the product. + * @param {string} [productCodeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [productCodeGt] Filter greater than the value. + * @param {string} [productCodeGte] Filter greater than or equal to the value. + * @param {string} [productCodeLt] Filter less than the value. + * @param {string} [productCodeLte] Filter less than or equal to the value. + * @param {string} [date] A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about products for the specified day (default=today). Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [sector] The sector to which the product belongs. + * @param {string} [sectorAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [sectorGt] Filter greater than the value. + * @param {string} [sectorGte] Filter greater than or equal to the value. + * @param {string} [sectorLt] Filter less than the value. + * @param {string} [sectorLte] Filter less than or equal to the value. + * @param {string} [subSector] The sub-sector to which the product belongs. + * @param {string} [subSectorAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [subSectorGt] Filter greater than the value. + * @param {string} [subSectorGte] Filter greater than or equal to the value. + * @param {string} [subSectorLt] Filter less than the value. + * @param {string} [subSectorLte] Filter less than or equal to the value. + * @param {string} [assetClass] The asset class to which the product belongs. + * @param {string} [assetClassAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [assetClassGt] Filter greater than the value. + * @param {string} [assetClassGte] Filter greater than or equal to the value. + * @param {string} [assetClassLt] Filter less than the value. + * @param {string} [assetClassLte] Filter less than or equal to the value. + * @param {string} [assetSubClass] The asset sub-class to which the product belongs. + * @param {string} [assetSubClassAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [assetSubClassGt] Filter greater than the value. + * @param {string} [assetSubClassGte] Filter greater than or equal to the value. + * @param {string} [assetSubClassLt] Filter less than the value. + * @param {string} [assetSubClassLte] Filter less than or equal to the value. + * @param {string} [type] The type of product, one of \'single\' or \'combo\'. + * @param {string} [typeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [typeGt] Filter greater than the value. + * @param {string} [typeGte] Filter greater than or equal to the value. + * @param {string} [typeLt] Filter less than the value. + * @param {string} [typeLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getFuturesVXProductsNew(name?: string, nameAnyOf?: string, nameGt?: string, nameGte?: string, nameLt?: string, nameLte?: string, productCode?: string, productCodeAnyOf?: string, productCodeGt?: string, productCodeGte?: string, productCodeLt?: string, productCodeLte?: string, date?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, sector?: string, sectorAnyOf?: string, sectorGt?: string, sectorGte?: string, sectorLt?: string, sectorLte?: string, subSector?: string, subSectorAnyOf?: string, subSectorGt?: string, subSectorGte?: string, subSectorLt?: string, subSectorLte?: string, assetClass?: string, assetClassAnyOf?: string, assetClassGt?: string, assetClassGte?: string, assetClassLt?: string, assetClassLte?: string, assetSubClass?: string, assetSubClassAnyOf?: string, assetSubClassGt?: string, assetSubClassGte?: string, assetSubClassLt?: string, assetSubClassLte?: string, type?: string, typeAnyOf?: string, typeGt?: string, typeGte?: string, typeLt?: string, typeLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getFuturesVXProductsNew(name, nameAnyOf, nameGt, nameGte, nameLt, nameLte, productCode, productCodeAnyOf, productCodeGt, productCodeGte, productCodeLt, productCodeLte, date, dateGt, dateGte, dateLt, dateLte, sector, sectorAnyOf, sectorGt, sectorGte, sectorLt, sectorLte, subSector, subSectorAnyOf, subSectorGt, subSectorGte, subSectorLt, subSectorLte, assetClass, assetClassAnyOf, assetClassGt, assetClassGte, assetClassLt, assetClassLte, assetSubClass, assetSubClassAnyOf, assetSubClassGt, assetSubClassGte, assetSubClassLt, assetSubClassLte, type, typeAnyOf, typeGt, typeGte, typeLt, typeLte, limit, sort, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.getFuturesVXProductsNew']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Retrieve a snapshot of the most recent futures contract data. + * @summary futures_snapshot_v1 API + * @param {string} [productCode] The code for the contracts\' underlying product. + * @param {string} [productCodeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [productCodeGt] Filter greater than the value. + * @param {string} [productCodeGte] Filter greater than or equal to the value. + * @param {string} [productCodeLt] Filter less than the value. + * @param {string} [productCodeLte] Filter less than or equal to the value. + * @param {string} [ticker] The futures contract identifier, including the base symbol and contract expiration (e.g., ESZ24 for the December 2024 S&P 500 E-mini contract). + * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickerGt] Filter greater than the value. + * @param {string} [tickerGte] Filter greater than or equal to the value. + * @param {string} [tickerLt] Filter less than the value. + * @param {string} [tickerLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'ticker\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getFuturesVXSnapshot(productCode?: string, productCodeAnyOf?: string, productCodeGt?: string, productCodeGte?: string, productCodeLt?: string, productCodeLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getFuturesVXSnapshot(productCode, productCodeAnyOf, productCodeGt, productCodeGte, productCodeLt, productCodeLte, ticker, tickerAnyOf, tickerGt, tickerGte, tickerLt, tickerLte, limit, sort, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.getFuturesVXSnapshot']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, /** * Get the daily open, high, low, and close (OHLC) for the entire cryptocurrency markets. * @summary Grouped Daily (Bars) @@ -23095,7 +30063,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetIndicesAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). - * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. + * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://massive.com/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -23357,7 +30325,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetOptionsAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). - * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. + * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://massive.com/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -23397,7 +30365,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { /** * Get an options contract * @summary Options Contract - * @param {string} optionsTicker Query for a contract by options ticker. You can learn more about the structure of options tickers [here](https://polygon.io/blog/how-to-read-a-stock-options-ticker/). + * @param {string} optionsTicker Query for a contract by options ticker. You can learn more about the structure of options tickers [here](https://massive.com/blog/how-to-read-a-stock-options-ticker/). * @param {string} [asOf] Specify a point in time for the contract as of this date with format YYYY-MM-DD. Defaults to today\'s date. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -23567,6 +30535,18 @@ export const DefaultApiFp = function(configuration?: Configuration) { const localVarOperationServerBasePath = operationServerMap['DefaultApi.getOptionsTrades']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * US options exchanges and trading venues including traditional options exchanges (CBOE, ISE, etc.), Securities Information Processors (SIP), and other options market infrastructure for derivatives trading. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'999\'. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getOptionsV1Exchanges(limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getOptionsV1Exchanges(limit, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.getOptionsV1Exchanges']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, /** * Get the previous day\'s open, high, low, and close (OHLC) for the specified cryptocurrency pair. * @summary Previous Close @@ -23652,7 +30632,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { /** * Get everything needed to visualize the tick-by-tick movement of a list of tickers. * @summary Summaries - * @param {string} [tickerAnyOf] Comma separated list of tickers. This API currently supports Stocks/Equities, Crypto, Options, and Forex. See <a rel=\"nofollow\" target=\"_blank\" href=\"https://polygon.io/docs/stocks/get_v3_reference_tickers\">the tickers endpoint</a> for more details on supported tickers. If no tickers are passed then no results will be returned. Warning: The maximum number of characters allowed in a URL are subject to your technology stack. + * @param {string} [tickerAnyOf] Comma separated list of tickers. This API currently supports Stocks/Equities, Crypto, Options, and Forex. See <a rel=\"nofollow\" target=\"_blank\" href=\"https://massive.com/docs/stocks/get_v3_reference_tickers\">the tickers endpoint</a> for more details on supported tickers. If no tickers are passed then no results will be returned. Warning: The maximum number of characters allowed in a URL are subject to your technology stack. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -23694,7 +30674,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetStocksAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). - * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. + * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://massive.com/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -23729,6 +30709,275 @@ export const DefaultApiFp = function(configuration?: Configuration) { const localVarOperationServerBasePath = operationServerMap['DefaultApi.getStocksEMA']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, + /** + * A comprehensive financial dataset containing quarterly and annual balance sheet data for public companies. Includes detailed asset, liability, and equity positions representing the company\'s financial position at specific points in time. Balance sheet data represents point-in-time snapshots rather than cumulative flows, showing what the company owns, owes, and shareholders\' equity as of each period end date. + * @param {string} [cik] The company\'s Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company\'s CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup). + * @param {string} [cikAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [cikGt] Filter greater than the value. + * @param {string} [cikGte] Filter greater than or equal to the value. + * @param {string} [cikLt] Filter less than the value. + * @param {string} [cikLte] Filter less than or equal to the value. + * @param {string} [tickers] Filter for arrays that contain the value. + * @param {string} [tickersAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickersAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [periodEnd] The last date of the reporting period, representing the specific point in time when the balance sheet snapshot was taken. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDate] The date when the financial statement was filed with the SEC. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {number} [fiscalYear] The fiscal year for the reporting period. Value must be a floating point number. + * @param {number} [fiscalYearGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [fiscalYearGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalYearLt] Filter less than the value. Value must be a floating point number. + * @param {number} [fiscalYearLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalQuarter] The fiscal quarter number (1, 2, 3, or 4) for the reporting period. Value must be a floating point number. + * @param {number} [fiscalQuarterGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [fiscalQuarterGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalQuarterLt] Filter less than the value. Value must be a floating point number. + * @param {number} [fiscalQuarterLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {string} [timeframe] The reporting period type. Possible values include: quarterly, annual. + * @param {string} [timeframeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [timeframeGt] Filter greater than the value. + * @param {string} [timeframeGte] Filter greater than or equal to the value. + * @param {string} [timeframeLt] Filter less than the value. + * @param {string} [timeframeLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'period_end\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getStocksFinancialsV1BalanceSheets(cik?: string, cikAnyOf?: string, cikGt?: string, cikGte?: string, cikLt?: string, cikLte?: string, tickers?: string, tickersAllOf?: string, tickersAnyOf?: string, periodEnd?: string, periodEndGt?: string, periodEndGte?: string, periodEndLt?: string, periodEndLte?: string, filingDate?: string, filingDateGt?: string, filingDateGte?: string, filingDateLt?: string, filingDateLte?: string, fiscalYear?: number, fiscalYearGt?: number, fiscalYearGte?: number, fiscalYearLt?: number, fiscalYearLte?: number, fiscalQuarter?: number, fiscalQuarterGt?: number, fiscalQuarterGte?: number, fiscalQuarterLt?: number, fiscalQuarterLte?: number, timeframe?: string, timeframeAnyOf?: string, timeframeGt?: string, timeframeGte?: string, timeframeLt?: string, timeframeLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getStocksFinancialsV1BalanceSheets(cik, cikAnyOf, cikGt, cikGte, cikLt, cikLte, tickers, tickersAllOf, tickersAnyOf, periodEnd, periodEndGt, periodEndGte, periodEndLt, periodEndLte, filingDate, filingDateGt, filingDateGte, filingDateLt, filingDateLte, fiscalYear, fiscalYearGt, fiscalYearGte, fiscalYearLt, fiscalYearLte, fiscalQuarter, fiscalQuarterGt, fiscalQuarterGte, fiscalQuarterLt, fiscalQuarterLte, timeframe, timeframeAnyOf, timeframeGt, timeframeGte, timeframeLt, timeframeLte, limit, sort, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.getStocksFinancialsV1BalanceSheets']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * A comprehensive financial dataset containing quarterly, annual, and trailing twelve-month cash flow statement data for public companies. Includes detailed operating, investing, and financing cash flows with proper TTM calculations that sum all cash flow components over four quarters. TTM records are validated to ensure exactly four distinct quarters spanning 250-400 days for accurate trailing twelve-month cash flow analysis. + * @param {string} [cik] The company\'s Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company’s CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup). + * @param {string} [cikAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [cikGt] Filter greater than the value. + * @param {string} [cikGte] Filter greater than or equal to the value. + * @param {string} [cikLt] Filter less than the value. + * @param {string} [cikLte] Filter less than or equal to the value. + * @param {string} [periodEnd] The last date of the reporting period (formatted as YYYY-MM-DD). Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDate] The date when the financial statement was filed with the SEC. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [tickers] Filter for arrays that contain the value. + * @param {string} [tickersAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickersAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {number} [fiscalYear] The fiscal year for the reporting period. Value must be a floating point number. + * @param {number} [fiscalYearGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [fiscalYearGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalYearLt] Filter less than the value. Value must be a floating point number. + * @param {number} [fiscalYearLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalQuarter] The fiscal quarter number (1, 2, 3, or 4) for the reporting period. Value must be a floating point number. + * @param {number} [fiscalQuarterGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [fiscalQuarterGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalQuarterLt] Filter less than the value. Value must be a floating point number. + * @param {number} [fiscalQuarterLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {string} [timeframe] The reporting period type. Possible values include: quarterly, annual, trailing_twelve_months. + * @param {string} [timeframeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [timeframeGt] Filter greater than the value. + * @param {string} [timeframeGte] Filter greater than or equal to the value. + * @param {string} [timeframeLt] Filter less than the value. + * @param {string} [timeframeLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'period_end\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getStocksFinancialsV1CashFlowStatements(cik?: string, cikAnyOf?: string, cikGt?: string, cikGte?: string, cikLt?: string, cikLte?: string, periodEnd?: string, periodEndGt?: string, periodEndGte?: string, periodEndLt?: string, periodEndLte?: string, filingDate?: string, filingDateGt?: string, filingDateGte?: string, filingDateLt?: string, filingDateLte?: string, tickers?: string, tickersAllOf?: string, tickersAnyOf?: string, fiscalYear?: number, fiscalYearGt?: number, fiscalYearGte?: number, fiscalYearLt?: number, fiscalYearLte?: number, fiscalQuarter?: number, fiscalQuarterGt?: number, fiscalQuarterGte?: number, fiscalQuarterLt?: number, fiscalQuarterLte?: number, timeframe?: string, timeframeAnyOf?: string, timeframeGt?: string, timeframeGte?: string, timeframeLt?: string, timeframeLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getStocksFinancialsV1CashFlowStatements(cik, cikAnyOf, cikGt, cikGte, cikLt, cikLte, periodEnd, periodEndGt, periodEndGte, periodEndLt, periodEndLte, filingDate, filingDateGt, filingDateGte, filingDateLt, filingDateLte, tickers, tickersAllOf, tickersAnyOf, fiscalYear, fiscalYearGt, fiscalYearGte, fiscalYearLt, fiscalYearLte, fiscalQuarter, fiscalQuarterGt, fiscalQuarterGte, fiscalQuarterLt, fiscalQuarterLte, timeframe, timeframeAnyOf, timeframeGt, timeframeGte, timeframeLt, timeframeLte, limit, sort, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.getStocksFinancialsV1CashFlowStatements']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * A comprehensive database of income statement financial data for public companies, including key metrics such as revenue, expenses, and net income for various reporting periods. + * @param {string} [cik] The company\'s Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company’s CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup). + * @param {string} [cikAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [cikGt] Filter greater than the value. + * @param {string} [cikGte] Filter greater than or equal to the value. + * @param {string} [cikLt] Filter less than the value. + * @param {string} [cikLte] Filter less than or equal to the value. + * @param {string} [tickers] Filter for arrays that contain the value. + * @param {string} [tickersAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickersAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [periodEnd] The last date of the reporting period (formatted as YYYY-MM-DD). Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDate] The date when the financial statement was filed with the SEC. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {number} [fiscalYear] The fiscal year for the reporting period. Value must be a floating point number. + * @param {number} [fiscalYearGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [fiscalYearGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalYearLt] Filter less than the value. Value must be a floating point number. + * @param {number} [fiscalYearLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalQuarter] The fiscal quarter number (1, 2, 3, or 4) for the reporting period. Value must be a floating point number. + * @param {number} [fiscalQuarterGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [fiscalQuarterGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalQuarterLt] Filter less than the value. Value must be a floating point number. + * @param {number} [fiscalQuarterLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {string} [timeframe] The reporting period type. Possible values include: quarterly, annual, trailing_twelve_months. + * @param {string} [timeframeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [timeframeGt] Filter greater than the value. + * @param {string} [timeframeGte] Filter greater than or equal to the value. + * @param {string} [timeframeLt] Filter less than the value. + * @param {string} [timeframeLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'period_end\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getStocksFinancialsV1IncomeStatements(cik?: string, cikAnyOf?: string, cikGt?: string, cikGte?: string, cikLt?: string, cikLte?: string, tickers?: string, tickersAllOf?: string, tickersAnyOf?: string, periodEnd?: string, periodEndGt?: string, periodEndGte?: string, periodEndLt?: string, periodEndLte?: string, filingDate?: string, filingDateGt?: string, filingDateGte?: string, filingDateLt?: string, filingDateLte?: string, fiscalYear?: number, fiscalYearGt?: number, fiscalYearGte?: number, fiscalYearLt?: number, fiscalYearLte?: number, fiscalQuarter?: number, fiscalQuarterGt?: number, fiscalQuarterGte?: number, fiscalQuarterLt?: number, fiscalQuarterLte?: number, timeframe?: string, timeframeAnyOf?: string, timeframeGt?: string, timeframeGte?: string, timeframeLt?: string, timeframeLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getStocksFinancialsV1IncomeStatements(cik, cikAnyOf, cikGt, cikGte, cikLt, cikLte, tickers, tickersAllOf, tickersAnyOf, periodEnd, periodEndGt, periodEndGte, periodEndLt, periodEndLte, filingDate, filingDateGt, filingDateGte, filingDateLt, filingDateLte, fiscalYear, fiscalYearGt, fiscalYearGte, fiscalYearLt, fiscalYearLte, fiscalQuarter, fiscalQuarterGt, fiscalQuarterGte, fiscalQuarterLt, fiscalQuarterLte, timeframe, timeframeAnyOf, timeframeGt, timeframeGte, timeframeLt, timeframeLte, limit, sort, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.getStocksFinancialsV1IncomeStatements']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * A comprehensive financial ratios dataset providing key valuation, profitability, liquidity, and leverage metrics for public companies. Combines data from income statements, balance sheets, and cash flow statements with daily stock prices to calculate ratios on a daily basis. Uses trailing twelve months (TTM) data for income/cash flow metrics and quarterly data for balance sheet items. Fundamental data updates are applied starting from each filing\'s period end date. Market cap calculations use point-in-time shares outstanding for historical accuracy. + * @param {string} [ticker] Stock ticker symbol for the company. + * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickerGt] Filter greater than the value. + * @param {string} [tickerGte] Filter greater than or equal to the value. + * @param {string} [tickerLt] Filter less than the value. + * @param {string} [tickerLte] Filter less than or equal to the value. + * @param {string} [cik] Central Index Key (CIK) number assigned by the SEC to identify the company. + * @param {string} [cikAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [cikGt] Filter greater than the value. + * @param {string} [cikGte] Filter greater than or equal to the value. + * @param {string} [cikLt] Filter less than the value. + * @param {string} [cikLte] Filter less than or equal to the value. + * @param {number} [price] Stock price used in ratio calculations, typically the closing price for the given date. Value must be a floating point number. + * @param {number} [priceGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [priceGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [priceLt] Filter less than the value. Value must be a floating point number. + * @param {number} [priceLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [averageVolume] Average trading volume over the last 30 trading days, providing context for liquidity. Value must be a floating point number. + * @param {number} [averageVolumeGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [averageVolumeGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [averageVolumeLt] Filter less than the value. Value must be a floating point number. + * @param {number} [averageVolumeLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [marketCap] Market capitalization, calculated as stock price multiplied by total shares outstanding. Value must be a floating point number. + * @param {number} [marketCapGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [marketCapGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [marketCapLt] Filter less than the value. Value must be a floating point number. + * @param {number} [marketCapLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [earningsPerShare] Earnings per share, calculated as net income available to common shareholders divided by weighted shares outstanding. Value must be a floating point number. + * @param {number} [earningsPerShareGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [earningsPerShareGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [earningsPerShareLt] Filter less than the value. Value must be a floating point number. + * @param {number} [earningsPerShareLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [priceToEarnings] Price-to-earnings ratio, calculated as stock price divided by earnings per share. Only calculated when earnings per share is positive. Value must be a floating point number. + * @param {number} [priceToEarningsGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [priceToEarningsGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [priceToEarningsLt] Filter less than the value. Value must be a floating point number. + * @param {number} [priceToEarningsLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [priceToBook] Price-to-book ratio, calculated as stock price divided by book value per share, comparing market value to book value. Value must be a floating point number. + * @param {number} [priceToBookGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [priceToBookGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [priceToBookLt] Filter less than the value. Value must be a floating point number. + * @param {number} [priceToBookLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [priceToSales] Price-to-sales ratio, calculated as stock price divided by revenue per share, measuring valuation relative to sales. Value must be a floating point number. + * @param {number} [priceToSalesGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [priceToSalesGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [priceToSalesLt] Filter less than the value. Value must be a floating point number. + * @param {number} [priceToSalesLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [priceToCashFlow] Price-to-cash-flow ratio, calculated as stock price divided by operating cash flow per share. Only calculated when operating cash flow per share is positive. Value must be a floating point number. + * @param {number} [priceToCashFlowGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [priceToCashFlowGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [priceToCashFlowLt] Filter less than the value. Value must be a floating point number. + * @param {number} [priceToCashFlowLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [priceToFreeCashFlow] Price-to-free-cash-flow ratio, calculated as stock price divided by free cash flow per share. Only calculated when free cash flow per share is positive. Value must be a floating point number. + * @param {number} [priceToFreeCashFlowGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [priceToFreeCashFlowGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [priceToFreeCashFlowLt] Filter less than the value. Value must be a floating point number. + * @param {number} [priceToFreeCashFlowLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [dividendYield] Dividend yield, calculated as annual dividends per share divided by stock price, measuring the income return on investment. Value must be a floating point number. + * @param {number} [dividendYieldGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [dividendYieldGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [dividendYieldLt] Filter less than the value. Value must be a floating point number. + * @param {number} [dividendYieldLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [returnOnAssets] Return on assets ratio, calculated as net income divided by total assets, measuring how efficiently a company uses its assets to generate profit. Value must be a floating point number. + * @param {number} [returnOnAssetsGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [returnOnAssetsGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [returnOnAssetsLt] Filter less than the value. Value must be a floating point number. + * @param {number} [returnOnAssetsLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [returnOnEquity] Return on equity ratio, calculated as net income divided by total shareholders\' equity, measuring profitability relative to shareholders\' equity. Value must be a floating point number. + * @param {number} [returnOnEquityGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [returnOnEquityGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [returnOnEquityLt] Filter less than the value. Value must be a floating point number. + * @param {number} [returnOnEquityLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [debtToEquity] Debt-to-equity ratio, calculated as total debt (current debt plus long-term debt) divided by total shareholders\' equity, measuring financial leverage. Value must be a floating point number. + * @param {number} [debtToEquityGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [debtToEquityGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [debtToEquityLt] Filter less than the value. Value must be a floating point number. + * @param {number} [debtToEquityLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [current] Current ratio, calculated as total current assets divided by total current liabilities, measuring short-term liquidity. Value must be a floating point number. + * @param {number} [currentGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [currentGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [currentLt] Filter less than the value. Value must be a floating point number. + * @param {number} [currentLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quick] Quick ratio (acid-test ratio), calculated as (current assets minus inventories) divided by current liabilities, measuring immediate liquidity. Value must be a floating point number. + * @param {number} [quickGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quickGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quickLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quickLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [cash] Cash ratio, calculated as cash and cash equivalents divided by current liabilities, measuring the most liquid form of liquidity coverage. Value must be a floating point number. + * @param {number} [cashGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [cashGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [cashLt] Filter less than the value. Value must be a floating point number. + * @param {number} [cashLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [evToSales] Enterprise value to sales ratio, calculated as enterprise value divided by revenue, measuring company valuation relative to sales. Value must be a floating point number. + * @param {number} [evToSalesGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [evToSalesGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [evToSalesLt] Filter less than the value. Value must be a floating point number. + * @param {number} [evToSalesLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [evToEbitda] Enterprise value to EBITDA ratio, calculated as enterprise value divided by EBITDA, measuring company valuation relative to earnings before interest, taxes, depreciation, and amortization. Value must be a floating point number. + * @param {number} [evToEbitdaGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [evToEbitdaGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [evToEbitdaLt] Filter less than the value. Value must be a floating point number. + * @param {number} [evToEbitdaLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [enterpriseValue] Enterprise value, calculated as market capitalization plus total debt minus cash and cash equivalents, representing total company value. Value must be a floating point number. + * @param {number} [enterpriseValueGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [enterpriseValueGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [enterpriseValueLt] Filter less than the value. Value must be a floating point number. + * @param {number} [enterpriseValueLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [freeCashFlow] Free cash flow, calculated as operating cash flow minus capital expenditures (purchase of property, plant, and equipment). Value must be a floating point number. + * @param {number} [freeCashFlowGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [freeCashFlowGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [freeCashFlowLt] Filter less than the value. Value must be a floating point number. + * @param {number} [freeCashFlowLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'ticker\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getStocksFinancialsV1Ratios(ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, cik?: string, cikAnyOf?: string, cikGt?: string, cikGte?: string, cikLt?: string, cikLte?: string, price?: number, priceGt?: number, priceGte?: number, priceLt?: number, priceLte?: number, averageVolume?: number, averageVolumeGt?: number, averageVolumeGte?: number, averageVolumeLt?: number, averageVolumeLte?: number, marketCap?: number, marketCapGt?: number, marketCapGte?: number, marketCapLt?: number, marketCapLte?: number, earningsPerShare?: number, earningsPerShareGt?: number, earningsPerShareGte?: number, earningsPerShareLt?: number, earningsPerShareLte?: number, priceToEarnings?: number, priceToEarningsGt?: number, priceToEarningsGte?: number, priceToEarningsLt?: number, priceToEarningsLte?: number, priceToBook?: number, priceToBookGt?: number, priceToBookGte?: number, priceToBookLt?: number, priceToBookLte?: number, priceToSales?: number, priceToSalesGt?: number, priceToSalesGte?: number, priceToSalesLt?: number, priceToSalesLte?: number, priceToCashFlow?: number, priceToCashFlowGt?: number, priceToCashFlowGte?: number, priceToCashFlowLt?: number, priceToCashFlowLte?: number, priceToFreeCashFlow?: number, priceToFreeCashFlowGt?: number, priceToFreeCashFlowGte?: number, priceToFreeCashFlowLt?: number, priceToFreeCashFlowLte?: number, dividendYield?: number, dividendYieldGt?: number, dividendYieldGte?: number, dividendYieldLt?: number, dividendYieldLte?: number, returnOnAssets?: number, returnOnAssetsGt?: number, returnOnAssetsGte?: number, returnOnAssetsLt?: number, returnOnAssetsLte?: number, returnOnEquity?: number, returnOnEquityGt?: number, returnOnEquityGte?: number, returnOnEquityLt?: number, returnOnEquityLte?: number, debtToEquity?: number, debtToEquityGt?: number, debtToEquityGte?: number, debtToEquityLt?: number, debtToEquityLte?: number, current?: number, currentGt?: number, currentGte?: number, currentLt?: number, currentLte?: number, quick?: number, quickGt?: number, quickGte?: number, quickLt?: number, quickLte?: number, cash?: number, cashGt?: number, cashGte?: number, cashLt?: number, cashLte?: number, evToSales?: number, evToSalesGt?: number, evToSalesGte?: number, evToSalesLt?: number, evToSalesLte?: number, evToEbitda?: number, evToEbitdaGt?: number, evToEbitdaGte?: number, evToEbitdaLt?: number, evToEbitdaLte?: number, enterpriseValue?: number, enterpriseValueGt?: number, enterpriseValueGte?: number, enterpriseValueLt?: number, enterpriseValueLte?: number, freeCashFlow?: number, freeCashFlowGt?: number, freeCashFlowGte?: number, freeCashFlowLt?: number, freeCashFlowLte?: number, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getStocksFinancialsV1Ratios(ticker, tickerAnyOf, tickerGt, tickerGte, tickerLt, tickerLte, cik, cikAnyOf, cikGt, cikGte, cikLt, cikLte, price, priceGt, priceGte, priceLt, priceLte, averageVolume, averageVolumeGt, averageVolumeGte, averageVolumeLt, averageVolumeLte, marketCap, marketCapGt, marketCapGte, marketCapLt, marketCapLte, earningsPerShare, earningsPerShareGt, earningsPerShareGte, earningsPerShareLt, earningsPerShareLte, priceToEarnings, priceToEarningsGt, priceToEarningsGte, priceToEarningsLt, priceToEarningsLte, priceToBook, priceToBookGt, priceToBookGte, priceToBookLt, priceToBookLte, priceToSales, priceToSalesGt, priceToSalesGte, priceToSalesLt, priceToSalesLte, priceToCashFlow, priceToCashFlowGt, priceToCashFlowGte, priceToCashFlowLt, priceToCashFlowLte, priceToFreeCashFlow, priceToFreeCashFlowGt, priceToFreeCashFlowGte, priceToFreeCashFlowLt, priceToFreeCashFlowLte, dividendYield, dividendYieldGt, dividendYieldGte, dividendYieldLt, dividendYieldLte, returnOnAssets, returnOnAssetsGt, returnOnAssetsGte, returnOnAssetsLt, returnOnAssetsLte, returnOnEquity, returnOnEquityGt, returnOnEquityGte, returnOnEquityLt, returnOnEquityLte, debtToEquity, debtToEquityGt, debtToEquityGte, debtToEquityLt, debtToEquityLte, current, currentGt, currentGte, currentLt, currentLte, quick, quickGt, quickGte, quickLt, quickLte, cash, cashGt, cashGte, cashLt, cashLte, evToSales, evToSalesGt, evToSalesGte, evToSalesLt, evToSalesLte, evToEbitda, evToEbitdaGt, evToEbitdaGte, evToEbitdaLt, evToEbitdaLte, enterpriseValue, enterpriseValueGt, enterpriseValueGte, enterpriseValueLt, enterpriseValueLte, freeCashFlow, freeCashFlowGt, freeCashFlowGte, freeCashFlowLt, freeCashFlowLte, limit, sort, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.getStocksFinancialsV1Ratios']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, /** * Get moving average convergence/divergence (MACD) data for a ticker symbol over a given time range. * @summary Moving Average Convergence/Divergence (MACD) @@ -23905,7 +31154,19 @@ export const DefaultApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** - * + * US stock exchanges, trading venues, and reporting facilities including exchanges (NYSE, Nasdaq), Trade Reporting Facilities (TRF), Securities Information Processors (SIP), and OTC Reporting Facilities (ORF) for equity trading. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'999\'. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getStocksV1Exchanges(limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getStocksV1Exchanges(limit, options); + const localVarOperationServerIndex = configuration?.serverIndex ?? 0; + const localVarOperationServerBasePath = operationServerMap['DefaultApi.getStocksV1Exchanges']?.[localVarOperationServerIndex]?.url; + return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); + }, + /** + * Comprehensive FINRA short interest data that tracks the short selling metrics for securities on a specific settlement date. * @param {string} [ticker] The primary ticker symbol for the stock. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. @@ -23942,7 +31203,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** - * + * Contains short selling volume for different stock tickers, capturing total trading volume, short sale details, and breakdown by different trading platforms. * @param {string} [ticker] The primary ticker symbol for the stock. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. @@ -23979,7 +31240,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** - * Get a single ticker supported by Polygon.io. This response will have detailed information about the ticker and the company behind it. + * Get a single ticker supported by Massive.com. This response will have detailed information about the ticker and the company behind it. * @summary Ticker Details v3 * @param {string} ticker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} [date] Specify a point in time to get information about the ticker available on that date. When retrieving information from SEC filings, we compare this date with the period of report date on the SEC filing. For example, consider an SEC filing submitted by AAPL on 2019-07-31, with a period of report date ending on 2019-06-29. That means that the filing was submitted on 2019-07-31, but the filing was created based on information from 2019-06-29. If you were to query for AAPL details on 2019-06-29, the ticker details would include information from the SEC filing. Defaults to the most recent available date. @@ -23993,7 +31254,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** - * + * Contains corporate events and announcements for publicly traded companies, including earnings releases, conferences, dividends, and business updates sourced from TMX. * @param {string} [date] Scheduled date of the corporate event, formatted as YYYY-MM-DD. * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. @@ -24031,7 +31292,6 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {string} [tradingVenueLt] Filter less than the value. * @param {string} [tradingVenueLte] Filter less than or equal to the value. * @param {number} [tmxCompanyId] Unique numeric identifier for the company used by TMX. Value must be an integer. - * @param {string} [tmxCompanyIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [tmxCompanyIdGt] Filter greater than the value. Value must be an integer. * @param {number} [tmxCompanyIdGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [tmxCompanyIdLt] Filter less than the value. Value must be an integer. @@ -24047,14 +31307,14 @@ export const DefaultApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getTmxV1CorporateEvents(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, type?: string, typeAnyOf?: string, typeGt?: string, typeGte?: string, typeLt?: string, typeLte?: string, status?: string, statusAnyOf?: string, statusGt?: string, statusGte?: string, statusLt?: string, statusLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, isin?: string, isinAnyOf?: string, isinGt?: string, isinGte?: string, isinLt?: string, isinLte?: string, tradingVenue?: string, tradingVenueAnyOf?: string, tradingVenueGt?: string, tradingVenueGte?: string, tradingVenueLt?: string, tradingVenueLte?: string, tmxCompanyId?: number, tmxCompanyIdAnyOf?: string, tmxCompanyIdGt?: number, tmxCompanyIdGte?: number, tmxCompanyIdLt?: number, tmxCompanyIdLte?: number, tmxRecordId?: string, tmxRecordIdAnyOf?: string, tmxRecordIdGt?: string, tmxRecordIdGte?: string, tmxRecordIdLt?: string, tmxRecordIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTmxV1CorporateEvents(date, dateAnyOf, dateGt, dateGte, dateLt, dateLte, type, typeAnyOf, typeGt, typeGte, typeLt, typeLte, status, statusAnyOf, statusGt, statusGte, statusLt, statusLte, ticker, tickerAnyOf, tickerGt, tickerGte, tickerLt, tickerLte, isin, isinAnyOf, isinGt, isinGte, isinLt, isinLte, tradingVenue, tradingVenueAnyOf, tradingVenueGt, tradingVenueGte, tradingVenueLt, tradingVenueLte, tmxCompanyId, tmxCompanyIdAnyOf, tmxCompanyIdGt, tmxCompanyIdGte, tmxCompanyIdLt, tmxCompanyIdLte, tmxRecordId, tmxRecordIdAnyOf, tmxRecordIdGt, tmxRecordIdGte, tmxRecordIdLt, tmxRecordIdLte, limit, sort, options); + async getTmxV1CorporateEvents(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, type?: string, typeAnyOf?: string, typeGt?: string, typeGte?: string, typeLt?: string, typeLte?: string, status?: string, statusAnyOf?: string, statusGt?: string, statusGte?: string, statusLt?: string, statusLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, isin?: string, isinAnyOf?: string, isinGt?: string, isinGte?: string, isinLt?: string, isinLte?: string, tradingVenue?: string, tradingVenueAnyOf?: string, tradingVenueGt?: string, tradingVenueGte?: string, tradingVenueLt?: string, tradingVenueLte?: string, tmxCompanyId?: number, tmxCompanyIdGt?: number, tmxCompanyIdGte?: number, tmxCompanyIdLt?: number, tmxCompanyIdLte?: number, tmxRecordId?: string, tmxRecordIdAnyOf?: string, tmxRecordIdGt?: string, tmxRecordIdGte?: string, tmxRecordIdLt?: string, tmxRecordIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTmxV1CorporateEvents(date, dateAnyOf, dateGt, dateGte, dateLt, dateLte, type, typeAnyOf, typeGt, typeGte, typeLt, typeLte, status, statusAnyOf, statusGt, statusGte, statusLt, statusLte, ticker, tickerAnyOf, tickerGt, tickerGte, tickerLt, tickerLte, isin, isinAnyOf, isinGt, isinGte, isinLt, isinLte, tradingVenue, tradingVenueAnyOf, tradingVenueGt, tradingVenueGte, tradingVenueLt, tradingVenueLte, tmxCompanyId, tmxCompanyIdGt, tmxCompanyIdGte, tmxCompanyIdLt, tmxCompanyIdLte, tmxRecordId, tmxRecordIdAnyOf, tmxRecordIdGt, tmxRecordIdGte, tmxRecordIdLt, tmxRecordIdLte, limit, sort, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['DefaultApi.getTmxV1CorporateEvents']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** - * List all conditions that Polygon.io uses. + * List all conditions that Massive.com uses. * @summary Conditions * @param {ListConditionsAssetClassEnum} [assetClass] Filter for conditions within a given asset class. * @param {ListConditionsDataTypeEnum} [dataType] Filter by data type. @@ -24120,7 +31380,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** - * List all exchanges that Polygon.io knows about. + * List all exchanges that Massive.com knows about. * @summary Exchanges * @param {ListExchangesAssetClassEnum} [assetClass] Filter by asset class. * @param {ListExchangesLocaleEnum} [locale] Filter by locale. @@ -24218,7 +31478,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { * Query for historical options contracts. This provides both active and expired options contracts. * @summary Options Contracts * @param {string} [underlyingTicker] Query for contracts relating to an underlying stock ticker. - * @param {string} [ticker] This parameter has been deprecated. To search by specific options ticker, use the Options Contract endpoint [here](https://polygon.io/docs/options/get_v3_reference_options_contracts__options_ticker). + * @param {string} [ticker] This parameter has been deprecated. To search by specific options ticker, use the Options Contract endpoint [here](https://massive.com/docs/options/get_v3_reference_options_contracts__options_ticker). * @param {ListOptionsContractsContractTypeEnum} [contractType] Query by the type of contract. * @param {string} [expirationDate] Query by contract expiration with date format YYYY-MM-DD. * @param {string} [asOf] Specify a point in time for contracts as of this date with format YYYY-MM-DD. Defaults to today\'s date. @@ -24275,7 +31535,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** - * List all ticker types that Polygon.io has. + * List all ticker types that Massive.com has. * @summary Ticker Types * @param {ListTickerTypesAssetClassEnum} [assetClass] Filter by asset class. * @param {ListTickerTypesLocaleEnum} [locale] Filter by locale. @@ -24289,10 +31549,10 @@ export const DefaultApiFp = function(configuration?: Configuration) { return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** - * Query all ticker symbols which are supported by Polygon.io. This API currently includes Stocks/Equities, Indices, Forex, and Crypto. + * Query all ticker symbols which are supported by Massive.com. This API currently includes Stocks/Equities, Indices, Forex, and Crypto. * @summary Tickers * @param {string} [ticker] Specify a ticker symbol. Defaults to empty string which queries all tickers. - * @param {ListTickersTypeEnum} [type] Specify the type of the tickers. Find the types that we support via our [Ticker Types API](https://polygon.io/docs/stocks/get_v3_reference_tickers_types). Defaults to empty string which queries all types. + * @param {ListTickersTypeEnum} [type] Specify the type of the tickers. Find the types that we support via our [Ticker Types API](https://massive.com/docs/stocks/get_v3_reference_tickers_types). Defaults to empty string which queries all types. * @param {ListTickersMarketEnum} [market] Filter by market type. By default all markets are included. * @param {string} [exchange] Specify the asset\'s primary exchange Market Identifier Code (MIC) according to [ISO 10383](https://www.iso20022.org/market-identifier-codes). Defaults to empty string which queries all exchanges. * @param {string} [cusip] Specify the CUSIP code of the asset you want to search for. Find more information about CUSIP codes [at their website](https://www.cusip.com/identifiers.html#/CUSIP). Defaults to empty string which queries all CUSIPs. Note: Although you can query by CUSIP, due to legal reasons we do not return the CUSIP in the response. @@ -24484,6 +31744,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * A comprehensive financial consensus ratings table that aggregates analyst recommendations and price targets for individual stock tickers, capturing detailed rating breakdowns and statistical insights. * @param {string} ticker The requested ticker. * @param {string} [date] The publication date of the news article. + * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. @@ -24492,8 +31753,8 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getBenzingaV1ConsensusRatings(ticker: string, date?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, options?: RawAxiosRequestConfig): Promise { - return localVarFp.getBenzingaV1ConsensusRatings(ticker, date, dateGt, dateGte, dateLt, dateLte, limit, options).then((request) => request(axios, basePath)); + getBenzingaV1ConsensusRatings(ticker: string, date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, options?: RawAxiosRequestConfig): Promise { + return localVarFp.getBenzingaV1ConsensusRatings(ticker, date, dateAnyOf, dateGt, dateGte, dateLt, dateLte, limit, options).then((request) => request(axios, basePath)); }, /** * This table contains earnings data from Benzinga, tracking both actual and estimated financial metrics for publicly traded companies. It includes EPS and revenue figures with surprise calculations, along with metadata like fiscal periods, company identifiers, and reporting timestamps. @@ -24515,12 +31776,12 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {number} [importanceGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [importanceLt] Filter less than the value. Value must be an integer. * @param {number} [importanceLte] Filter less than or equal to the value. Value must be an integer. - * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system. - * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [lastUpdatedGt] Filter greater than the value. - * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. - * @param {string} [lastUpdatedLt] Filter less than the value. - * @param {string} [lastUpdatedLte] Filter less than or equal to the value. + * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedGt] Filter greater than the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedLt] Filter less than the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedLte] Filter less than or equal to the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. * @param {string} [dateStatus] Indicates whether the date of the earnings report has been confirmed. Possible values include: projected, confirmed. * @param {string} [dateStatusAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateStatusGt] Filter greater than the value. @@ -24552,7 +31813,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {string} [fiscalPeriodLt] Filter less than the value. * @param {string} [fiscalPeriodLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. - * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'last_updated\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -24679,17 +31940,15 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {number} [importance] A subjective indicator of the importance of the earnings event, on a scale from 0 (lowest) to 5 (highest). Value must be an integer. - * @param {string} [importanceAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [importanceGt] Filter greater than the value. Value must be an integer. * @param {number} [importanceGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [importanceLt] Filter less than the value. Value must be an integer. * @param {number} [importanceLte] Filter less than or equal to the value. Value must be an integer. - * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system. - * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [lastUpdatedGt] Filter greater than the value. - * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. - * @param {string} [lastUpdatedLt] Filter less than the value. - * @param {string} [lastUpdatedLte] Filter less than or equal to the value. + * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedGt] Filter greater than the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedLt] Filter less than the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedLte] Filter less than or equal to the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. * @param {string} [ratingAction] The description of the change in rating from the firm\'s last rating. Possible values include: downgrades, maintains, reinstates, reiterates, upgrades, assumes, initiates_coverage_on, terminates_coverage_on, removes, suspends, firm_dissolved. * @param {string} [ratingActionAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [ratingActionGt] Filter greater than the value. @@ -24721,12 +31980,45 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {string} [benzingaFirmIdLt] Filter less than the value. * @param {string} [benzingaFirmIdLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. - * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'last_updated\' if not specified. The sort order defaults to \'desc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getBenzingaV1Ratings(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, importance?: number, importanceGt?: number, importanceGte?: number, importanceLt?: number, importanceLte?: number, lastUpdated?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, ratingAction?: string, ratingActionAnyOf?: string, ratingActionGt?: string, ratingActionGte?: string, ratingActionLt?: string, ratingActionLte?: string, priceTargetAction?: string, priceTargetActionAnyOf?: string, priceTargetActionGt?: string, priceTargetActionGte?: string, priceTargetActionLt?: string, priceTargetActionLte?: string, benzingaId?: string, benzingaIdAnyOf?: string, benzingaIdGt?: string, benzingaIdGte?: string, benzingaIdLt?: string, benzingaIdLte?: string, benzingaAnalystId?: string, benzingaAnalystIdAnyOf?: string, benzingaAnalystIdGt?: string, benzingaAnalystIdGte?: string, benzingaAnalystIdLt?: string, benzingaAnalystIdLte?: string, benzingaFirmId?: string, benzingaFirmIdAnyOf?: string, benzingaFirmIdGt?: string, benzingaFirmIdGte?: string, benzingaFirmIdLt?: string, benzingaFirmIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise { + return localVarFp.getBenzingaV1Ratings(date, dateAnyOf, dateGt, dateGte, dateLt, dateLte, ticker, tickerAnyOf, tickerGt, tickerGte, tickerLt, tickerLte, importance, importanceGt, importanceGte, importanceLt, importanceLte, lastUpdated, lastUpdatedGt, lastUpdatedGte, lastUpdatedLt, lastUpdatedLte, ratingAction, ratingActionAnyOf, ratingActionGt, ratingActionGte, ratingActionLt, ratingActionLte, priceTargetAction, priceTargetActionAnyOf, priceTargetActionGt, priceTargetActionGte, priceTargetActionLt, priceTargetActionLte, benzingaId, benzingaIdAnyOf, benzingaIdGt, benzingaIdGte, benzingaIdLt, benzingaIdLte, benzingaAnalystId, benzingaAnalystIdAnyOf, benzingaAnalystIdGt, benzingaAnalystIdGte, benzingaAnalystIdLt, benzingaAnalystIdLte, benzingaFirmId, benzingaFirmIdAnyOf, benzingaFirmIdGt, benzingaFirmIdGte, benzingaFirmIdLt, benzingaFirmIdLte, limit, sort, options).then((request) => request(axios, basePath)); + }, + /** + * A comprehensive news article database from Benzinga, containing detailed information about financial news articles including metadata, content, and associated financial information. + * @param {string} [published] The timestamp (formatted as an ISO 8601 timestamp) when the news article was originally published. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [publishedGt] Filter greater than the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [publishedGte] Filter greater than or equal to the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [publishedLt] Filter less than the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [publishedLte] Filter less than or equal to the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [channels] Filter for arrays that contain the value. + * @param {string} [channelsAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [channelsAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tags] Filter for arrays that contain the value. + * @param {string} [tagsAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tagsAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [author] The name of the journalist or entity that authored the news article. + * @param {string} [authorAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [authorGt] Filter greater than the value. + * @param {string} [authorGte] Filter greater than or equal to the value. + * @param {string} [authorLt] Filter less than the value. + * @param {string} [authorLte] Filter less than or equal to the value. + * @param {string} [stocks] Filter for arrays that contain the value. + * @param {string} [stocksAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [stocksAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickers] Filter for arrays that contain the value. + * @param {string} [tickersAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickersAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'published\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getBenzingaV1Ratings(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, importance?: number, importanceAnyOf?: string, importanceGt?: number, importanceGte?: number, importanceLt?: number, importanceLte?: number, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, ratingAction?: string, ratingActionAnyOf?: string, ratingActionGt?: string, ratingActionGte?: string, ratingActionLt?: string, ratingActionLte?: string, priceTargetAction?: string, priceTargetActionAnyOf?: string, priceTargetActionGt?: string, priceTargetActionGte?: string, priceTargetActionLt?: string, priceTargetActionLte?: string, benzingaId?: string, benzingaIdAnyOf?: string, benzingaIdGt?: string, benzingaIdGte?: string, benzingaIdLt?: string, benzingaIdLte?: string, benzingaAnalystId?: string, benzingaAnalystIdAnyOf?: string, benzingaAnalystIdGt?: string, benzingaAnalystIdGte?: string, benzingaAnalystIdLt?: string, benzingaAnalystIdLte?: string, benzingaFirmId?: string, benzingaFirmIdAnyOf?: string, benzingaFirmIdGt?: string, benzingaFirmIdGte?: string, benzingaFirmIdLt?: string, benzingaFirmIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise { - return localVarFp.getBenzingaV1Ratings(date, dateAnyOf, dateGt, dateGte, dateLt, dateLte, ticker, tickerAnyOf, tickerGt, tickerGte, tickerLt, tickerLte, importance, importanceAnyOf, importanceGt, importanceGte, importanceLt, importanceLte, lastUpdated, lastUpdatedAnyOf, lastUpdatedGt, lastUpdatedGte, lastUpdatedLt, lastUpdatedLte, ratingAction, ratingActionAnyOf, ratingActionGt, ratingActionGte, ratingActionLt, ratingActionLte, priceTargetAction, priceTargetActionAnyOf, priceTargetActionGt, priceTargetActionGte, priceTargetActionLt, priceTargetActionLte, benzingaId, benzingaIdAnyOf, benzingaIdGt, benzingaIdGte, benzingaIdLt, benzingaIdLte, benzingaAnalystId, benzingaAnalystIdAnyOf, benzingaAnalystIdGt, benzingaAnalystIdGte, benzingaAnalystIdLt, benzingaAnalystIdLte, benzingaFirmId, benzingaFirmIdAnyOf, benzingaFirmIdGt, benzingaFirmIdGte, benzingaFirmIdLt, benzingaFirmIdLte, limit, sort, options).then((request) => request(axios, basePath)); + getBenzingaV2News(published?: string, publishedGt?: string, publishedGte?: string, publishedLt?: string, publishedLte?: string, channels?: string, channelsAllOf?: string, channelsAnyOf?: string, tags?: string, tagsAllOf?: string, tagsAnyOf?: string, author?: string, authorAnyOf?: string, authorGt?: string, authorGte?: string, authorLt?: string, authorLte?: string, stocks?: string, stocksAllOf?: string, stocksAnyOf?: string, tickers?: string, tickersAllOf?: string, tickersAnyOf?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise { + return localVarFp.getBenzingaV2News(published, publishedGt, publishedGte, publishedLt, publishedLte, channels, channelsAllOf, channelsAnyOf, tags, tagsAllOf, tagsAnyOf, author, authorAnyOf, authorGt, authorGte, authorLt, authorLte, stocks, stocksAllOf, stocksAnyOf, tickers, tickersAllOf, tickersAnyOf, limit, sort, options).then((request) => request(axios, basePath)); }, /** * Get aggregate bars for a cryptocurrency pair over a given date range in custom time window sizes.

For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned. @@ -24738,7 +32030,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetCryptoAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). - * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. + * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://massive.com/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -24892,6 +32184,15 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa getCryptoTrades(cryptoTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetCryptoTradesOrderEnum, limit?: number, sort?: GetCryptoTradesSortEnum, options?: RawAxiosRequestConfig): Promise { return localVarFp.getCryptoTrades(cryptoTicker, timestamp, timestampGte, timestampGt, timestampLte, timestampLt, order, limit, sort, options).then((request) => request(axios, basePath)); }, + /** + * Global cryptocurrency exchanges and digital asset trading platforms, including major centralized exchanges (Coinbase, Binance, Bitfinex, etc.) that facilitate trading of cryptocurrencies and digital tokens worldwide. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'999\'. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getCryptoV1Exchanges(limit?: number, options?: RawAxiosRequestConfig): Promise { + return localVarFp.getCryptoV1Exchanges(limit, options).then((request) => request(axios, basePath)); + }, /** * Get currency conversions using the latest market conversion rates. Note than you can convert in both directions. For example USD to CAD or CAD to USD. * @summary Real-time Currency Conversion @@ -24905,10 +32206,221 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa getCurrencyConversion(from: string, to: string, amount?: number, precision?: GetCurrencyConversionPrecisionEnum, options?: RawAxiosRequestConfig): Promise { return localVarFp.getCurrencyConversion(from, to, amount, precision, options).then((request) => request(axios, basePath)); }, + /** + * ETF Global analytics data containing risk scores, reward metrics, and quantitative analysis for ETF composite tickers. + * @param {string} [compositeTicker] The stock ticker symbol used to identify this ETF product on exchanges. + * @param {string} [compositeTickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [compositeTickerGt] Filter greater than the value. + * @param {string} [compositeTickerGte] Filter greater than or equal to the value. + * @param {string} [compositeTickerLt] Filter less than the value. + * @param {string} [compositeTickerLte] Filter less than or equal to the value. + * @param {string} [processedDate] The date showing when ETF Global received and processed the data. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDate] The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {number} [riskTotalScore] ETF Global\'s proprietary Red Diamond overall risk assessment score for the ETF. Value must be a floating point number. + * @param {number} [riskTotalScoreGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [riskTotalScoreGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [riskTotalScoreLt] Filter less than the value. Value must be a floating point number. + * @param {number} [riskTotalScoreLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [rewardScore] ETF Global\'s proprietary Green Diamond score measuring the potential reward and return prospects of the ETF. Value must be a floating point number. + * @param {number} [rewardScoreGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [rewardScoreGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [rewardScoreLt] Filter less than the value. Value must be a floating point number. + * @param {number} [rewardScoreLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quantTotalScore] ETF Global\'s comprehensive quantitative analysis score combining all quantitative factors. Value must be a floating point number. + * @param {number} [quantTotalScoreGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantTotalScoreGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantTotalScoreLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantTotalScoreLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {string} [quantGrade] Letter grade summarizing the ETF\'s overall quantitative assessment, where A = 71-100, B = 56-70, etc. + * @param {string} [quantGradeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [quantGradeGt] Filter greater than the value. + * @param {string} [quantGradeGte] Filter greater than or equal to the value. + * @param {string} [quantGradeLt] Filter less than the value. + * @param {string} [quantGradeLte] Filter less than or equal to the value. + * @param {number} [quantCompositeTechnical] Combined technical analysis score aggregating short, intermediate, and long-term technical factors. Value must be a floating point number. + * @param {number} [quantCompositeTechnicalGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantCompositeTechnicalGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeTechnicalLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantCompositeTechnicalLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeSentiment] Overall market sentiment score combining put/call ratios, short interest, and implied volatility. Value must be a floating point number. + * @param {number} [quantCompositeSentimentGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantCompositeSentimentGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeSentimentLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantCompositeSentimentLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeBehavioral] Behavioral analysis score measuring investor psychology and market behavior patterns. Value must be a floating point number. + * @param {number} [quantCompositeBehavioralGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantCompositeBehavioralGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeBehavioralLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantCompositeBehavioralLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeFundamental] Overall fundamental analysis score combining P/E, P/CF, P/B, and dividend yield metrics. Value must be a floating point number. + * @param {number} [quantCompositeFundamentalGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantCompositeFundamentalGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeFundamentalLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantCompositeFundamentalLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeGlobal] Overall global theme score combining sector and country analysis for macro investment views. Value must be a floating point number. + * @param {number} [quantCompositeGlobalGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantCompositeGlobalGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeGlobalLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantCompositeGlobalLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeQuality] Overall quality assessment score combining liquidity, diversification, and issuing firm factors. Value must be a floating point number. + * @param {number} [quantCompositeQualityGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantCompositeQualityGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeQualityLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantCompositeQualityLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'5000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'composite_ticker\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getEtfGlobalV1Analytics(compositeTicker?: string, compositeTickerAnyOf?: string, compositeTickerGt?: string, compositeTickerGte?: string, compositeTickerLt?: string, compositeTickerLte?: string, processedDate?: string, processedDateGt?: string, processedDateGte?: string, processedDateLt?: string, processedDateLte?: string, effectiveDate?: string, effectiveDateGt?: string, effectiveDateGte?: string, effectiveDateLt?: string, effectiveDateLte?: string, riskTotalScore?: number, riskTotalScoreGt?: number, riskTotalScoreGte?: number, riskTotalScoreLt?: number, riskTotalScoreLte?: number, rewardScore?: number, rewardScoreGt?: number, rewardScoreGte?: number, rewardScoreLt?: number, rewardScoreLte?: number, quantTotalScore?: number, quantTotalScoreGt?: number, quantTotalScoreGte?: number, quantTotalScoreLt?: number, quantTotalScoreLte?: number, quantGrade?: string, quantGradeAnyOf?: string, quantGradeGt?: string, quantGradeGte?: string, quantGradeLt?: string, quantGradeLte?: string, quantCompositeTechnical?: number, quantCompositeTechnicalGt?: number, quantCompositeTechnicalGte?: number, quantCompositeTechnicalLt?: number, quantCompositeTechnicalLte?: number, quantCompositeSentiment?: number, quantCompositeSentimentGt?: number, quantCompositeSentimentGte?: number, quantCompositeSentimentLt?: number, quantCompositeSentimentLte?: number, quantCompositeBehavioral?: number, quantCompositeBehavioralGt?: number, quantCompositeBehavioralGte?: number, quantCompositeBehavioralLt?: number, quantCompositeBehavioralLte?: number, quantCompositeFundamental?: number, quantCompositeFundamentalGt?: number, quantCompositeFundamentalGte?: number, quantCompositeFundamentalLt?: number, quantCompositeFundamentalLte?: number, quantCompositeGlobal?: number, quantCompositeGlobalGt?: number, quantCompositeGlobalGte?: number, quantCompositeGlobalLt?: number, quantCompositeGlobalLte?: number, quantCompositeQuality?: number, quantCompositeQualityGt?: number, quantCompositeQualityGte?: number, quantCompositeQualityLt?: number, quantCompositeQualityLte?: number, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise { + return localVarFp.getEtfGlobalV1Analytics(compositeTicker, compositeTickerAnyOf, compositeTickerGt, compositeTickerGte, compositeTickerLt, compositeTickerLte, processedDate, processedDateGt, processedDateGte, processedDateLt, processedDateLte, effectiveDate, effectiveDateGt, effectiveDateGte, effectiveDateLt, effectiveDateLte, riskTotalScore, riskTotalScoreGt, riskTotalScoreGte, riskTotalScoreLt, riskTotalScoreLte, rewardScore, rewardScoreGt, rewardScoreGte, rewardScoreLt, rewardScoreLte, quantTotalScore, quantTotalScoreGt, quantTotalScoreGte, quantTotalScoreLt, quantTotalScoreLte, quantGrade, quantGradeAnyOf, quantGradeGt, quantGradeGte, quantGradeLt, quantGradeLte, quantCompositeTechnical, quantCompositeTechnicalGt, quantCompositeTechnicalGte, quantCompositeTechnicalLt, quantCompositeTechnicalLte, quantCompositeSentiment, quantCompositeSentimentGt, quantCompositeSentimentGte, quantCompositeSentimentLt, quantCompositeSentimentLte, quantCompositeBehavioral, quantCompositeBehavioralGt, quantCompositeBehavioralGte, quantCompositeBehavioralLt, quantCompositeBehavioralLte, quantCompositeFundamental, quantCompositeFundamentalGt, quantCompositeFundamentalGte, quantCompositeFundamentalLt, quantCompositeFundamentalLte, quantCompositeGlobal, quantCompositeGlobalGt, quantCompositeGlobalGte, quantCompositeGlobalLt, quantCompositeGlobalLte, quantCompositeQuality, quantCompositeQualityGt, quantCompositeQualityGte, quantCompositeQualityLt, quantCompositeQualityLte, limit, sort, options).then((request) => request(axios, basePath)); + }, + /** + * ETF Global constituents data containing detailed information about the securities held within ETFs, including weights, market values, and security identifiers. + * @param {string} [compositeTicker] The stock ticker symbol of the ETF that holds these constituent securities. + * @param {string} [compositeTickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [compositeTickerGt] Filter greater than the value. + * @param {string} [compositeTickerGte] Filter greater than or equal to the value. + * @param {string} [compositeTickerLt] Filter less than the value. + * @param {string} [compositeTickerLte] Filter less than or equal to the value. + * @param {string} [constituentTicker] The stock ticker symbol of the individual security held within the ETF. + * @param {string} [constituentTickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [constituentTickerGt] Filter greater than the value. + * @param {string} [constituentTickerGte] Filter greater than or equal to the value. + * @param {string} [constituentTickerLt] Filter less than the value. + * @param {string} [constituentTickerLte] Filter less than or equal to the value. + * @param {string} [effectiveDate] The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDate] The date showing when ETF Global received and processed the data. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [usCode] A unique identifier code for the constituent security in US markets. + * @param {string} [usCodeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [usCodeGt] Filter greater than the value. + * @param {string} [usCodeGte] Filter greater than or equal to the value. + * @param {string} [usCodeLt] Filter less than the value. + * @param {string} [usCodeLte] Filter less than or equal to the value. + * @param {string} [isin] The International Securities Identification Number, a global standard for identifying securities. + * @param {string} [isinAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [isinGt] Filter greater than the value. + * @param {string} [isinGte] Filter greater than or equal to the value. + * @param {string} [isinLt] Filter less than the value. + * @param {string} [isinLte] Filter less than or equal to the value. + * @param {string} [figi] The Financial Instrument Global Identifier, an open standard for uniquely identifying financial instruments. + * @param {string} [figiAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [figiGt] Filter greater than the value. + * @param {string} [figiGte] Filter greater than or equal to the value. + * @param {string} [figiLt] Filter less than the value. + * @param {string} [figiLte] Filter less than or equal to the value. + * @param {string} [sedol] The Stock Exchange Daily Official List code, primarily used for securities trading in the UK. + * @param {string} [sedolAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [sedolGt] Filter greater than the value. + * @param {string} [sedolGte] Filter greater than or equal to the value. + * @param {string} [sedolLt] Filter less than the value. + * @param {string} [sedolLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'5000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'composite_ticker\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getEtfGlobalV1Constituents(compositeTicker?: string, compositeTickerAnyOf?: string, compositeTickerGt?: string, compositeTickerGte?: string, compositeTickerLt?: string, compositeTickerLte?: string, constituentTicker?: string, constituentTickerAnyOf?: string, constituentTickerGt?: string, constituentTickerGte?: string, constituentTickerLt?: string, constituentTickerLte?: string, effectiveDate?: string, effectiveDateGt?: string, effectiveDateGte?: string, effectiveDateLt?: string, effectiveDateLte?: string, processedDate?: string, processedDateGt?: string, processedDateGte?: string, processedDateLt?: string, processedDateLte?: string, usCode?: string, usCodeAnyOf?: string, usCodeGt?: string, usCodeGte?: string, usCodeLt?: string, usCodeLte?: string, isin?: string, isinAnyOf?: string, isinGt?: string, isinGte?: string, isinLt?: string, isinLte?: string, figi?: string, figiAnyOf?: string, figiGt?: string, figiGte?: string, figiLt?: string, figiLte?: string, sedol?: string, sedolAnyOf?: string, sedolGt?: string, sedolGte?: string, sedolLt?: string, sedolLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise { + return localVarFp.getEtfGlobalV1Constituents(compositeTicker, compositeTickerAnyOf, compositeTickerGt, compositeTickerGte, compositeTickerLt, compositeTickerLte, constituentTicker, constituentTickerAnyOf, constituentTickerGt, constituentTickerGte, constituentTickerLt, constituentTickerLte, effectiveDate, effectiveDateGt, effectiveDateGte, effectiveDateLt, effectiveDateLte, processedDate, processedDateGt, processedDateGte, processedDateLt, processedDateLte, usCode, usCodeAnyOf, usCodeGt, usCodeGte, usCodeLt, usCodeLte, isin, isinAnyOf, isinGt, isinGte, isinLt, isinLte, figi, figiAnyOf, figiGt, figiGte, figiLt, figiLte, sedol, sedolAnyOf, sedolGt, sedolGte, sedolLt, sedolLte, limit, sort, options).then((request) => request(axios, basePath)); + }, + /** + * ETF Global fund flow data containing information about ETF share movements, net asset values, and fund flow metrics. + * @param {string} [processedDate] The date showing when ETF Global received and processed the data. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDate] The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [compositeTicker] The stock ticker symbol used to identify this ETF on exchanges. + * @param {string} [compositeTickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [compositeTickerGt] Filter greater than the value. + * @param {string} [compositeTickerGte] Filter greater than or equal to the value. + * @param {string} [compositeTickerLt] Filter less than the value. + * @param {string} [compositeTickerLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'5000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'composite_ticker\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getEtfGlobalV1FundFlows(processedDate?: string, processedDateGt?: string, processedDateGte?: string, processedDateLt?: string, processedDateLte?: string, effectiveDate?: string, effectiveDateGt?: string, effectiveDateGte?: string, effectiveDateLt?: string, effectiveDateLte?: string, compositeTicker?: string, compositeTickerAnyOf?: string, compositeTickerGt?: string, compositeTickerGte?: string, compositeTickerLt?: string, compositeTickerLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise { + return localVarFp.getEtfGlobalV1FundFlows(processedDate, processedDateGt, processedDateGte, processedDateLt, processedDateLte, effectiveDate, effectiveDateGt, effectiveDateGte, effectiveDateLt, effectiveDateLte, compositeTicker, compositeTickerAnyOf, compositeTickerGt, compositeTickerGte, compositeTickerLt, compositeTickerLte, limit, sort, options).then((request) => request(axios, basePath)); + }, + /** + * ETF Global industry profile data containing comprehensive ETF metadata including financial metrics, operational details, and exposure information. + * @param {string} [processedDate] The date showing when ETF Global received and processed the data. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDate] The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [compositeTicker] The stock ticker symbol used to identify this ETF product on exchanges. + * @param {string} [compositeTickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [compositeTickerGt] Filter greater than the value. + * @param {string} [compositeTickerGte] Filter greater than or equal to the value. + * @param {string} [compositeTickerLt] Filter less than the value. + * @param {string} [compositeTickerLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'5000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'composite_ticker\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getEtfGlobalV1Profiles(processedDate?: string, processedDateGt?: string, processedDateGte?: string, processedDateLt?: string, processedDateLte?: string, effectiveDate?: string, effectiveDateGt?: string, effectiveDateGte?: string, effectiveDateLt?: string, effectiveDateLte?: string, compositeTicker?: string, compositeTickerAnyOf?: string, compositeTickerGt?: string, compositeTickerGte?: string, compositeTickerLt?: string, compositeTickerLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise { + return localVarFp.getEtfGlobalV1Profiles(processedDate, processedDateGt, processedDateGte, processedDateLt, processedDateLte, effectiveDate, effectiveDateGt, effectiveDateGte, effectiveDateLt, effectiveDateLte, compositeTicker, compositeTickerAnyOf, compositeTickerGt, compositeTickerGte, compositeTickerLt, compositeTickerLte, limit, sort, options).then((request) => request(axios, basePath)); + }, + /** + * ETF Global taxonomy data containing detailed classification and categorization information for ETFs including investment strategy, methodology, and structural characteristics. + * @param {string} [processedDate] The date showing when ETF Global received and processed the data. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDate] The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [compositeTicker] The stock ticker symbol used to identify this ETF product on exchanges. + * @param {string} [compositeTickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [compositeTickerGt] Filter greater than the value. + * @param {string} [compositeTickerGte] Filter greater than or equal to the value. + * @param {string} [compositeTickerLt] Filter less than the value. + * @param {string} [compositeTickerLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'5000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'composite_ticker\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getEtfGlobalV1Taxonomies(processedDate?: string, processedDateGt?: string, processedDateGte?: string, processedDateLt?: string, processedDateLte?: string, effectiveDate?: string, effectiveDateGt?: string, effectiveDateGte?: string, effectiveDateLt?: string, effectiveDateLte?: string, compositeTicker?: string, compositeTickerAnyOf?: string, compositeTickerGt?: string, compositeTickerGte?: string, compositeTickerLt?: string, compositeTickerLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise { + return localVarFp.getEtfGlobalV1Taxonomies(processedDate, processedDateGt, processedDateGte, processedDateLt, processedDateLte, effectiveDate, effectiveDateGt, effectiveDateGte, effectiveDateLt, effectiveDateLte, compositeTicker, compositeTickerAnyOf, compositeTickerGt, compositeTickerGte, compositeTickerLt, compositeTickerLte, limit, sort, options).then((request) => request(axios, basePath)); + }, /** * Get a timeline of events for the entity associated with the given ticker, CUSIP, or Composite FIGI. * @summary Ticker Events - * @param {string} id Identifier of an asset, which can be a Ticker, CUSIP, or Composite FIGI. Specify a case-sensitive ticker symbol (e.g. AAPL for Apple Inc). When provided a ticker, events for the entity currently represented by that ticker are returned. To find events for entities previously associated with a ticker, obtain the relevant identifier using the [Ticker Details Endpoint](https://polygon.io/docs/stocks/get_v3_reference_tickers__ticker). + * @param {string} id Identifier of an asset, which can be a Ticker, CUSIP, or Composite FIGI. Specify a case-sensitive ticker symbol (e.g. AAPL for Apple Inc). When provided a ticker, events for the entity currently represented by that ticker are returned. To find events for entities previously associated with a ticker, obtain the relevant identifier using the [Ticker Details Endpoint](https://massive.com/docs/stocks/get_v3_reference_tickers__ticker). * @param {string} [types] A comma-separated list of the types of event to include. Currently ticker_change is the only supported event_type. Leave blank to return all supported event_types. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -24974,7 +32486,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetForexAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). - * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. + * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://massive.com/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -25119,12 +32631,21 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa getForexSnapshotTickers(tickers?: Array, options?: RawAxiosRequestConfig): Promise { return localVarFp.getForexSnapshotTickers(tickers, options).then((request) => request(axios, basePath)); }, + /** + * Global foreign exchange (FX) trading venues and market infrastructure, including electronic trading platforms, banks, and other institutions facilitating currency pair trading worldwide. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'999\'. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getForexV1Exchanges(limit?: number, options?: RawAxiosRequestConfig): Promise { + return localVarFp.getForexV1Exchanges(limit, options).then((request) => request(axios, basePath)); + }, /** * Get aggregates for a contract in a given time range. * @summary Aggregates * @param {string} ticker The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract). * @param {string} [resolution] This sets the size of the aggregate windows. It accepts custom values that specify the granularity and the duration of the window. For example: 15mins, 30secs, 12hours, or 7days. There are maximum allowable candle sizes. For example, you can request \"1min\" to \"59mins\", but after that you will need to use \"1hr\". If you make a request for a candle size that is not supported, we will return a 400 \"Bad Request - resolution value is not allowed.\" - * @param {string} [windowStart] This sets the range of time for your results. The window_start timestamp you choose specifies the starting edge of the candle or candles you want returned. If no value is set, you will get the oldest or newest available candles, depending on your sort order. You can combine window_start to form a time range, for example: window_start.gte=2024-01-01&window_start.lte=2024-01-31 + * @param {string} [windowStart] Specifies the start time of the aggregate (OHLC) candles you want returned (YYYY-MM-DD date or nanosecond Unix timestamp). How it works - If not provided, the API returns the most recent candles available, up to the limit you set. - If provided, the value determines which candle(s) to return. The timestamp or date is “snapped” to the start time of the matching candle interval. - You can use comparison operators to form ranges: - `window_start.gte` – greater than or equal to - `window_start.gt` – greater than - `window_start.lte` – less than or equal to - `window_start.lt` – less than Examples 1. Most recent minute candles `/vX/aggs/ESU5?resolution=1min&limit=5` 2. Daily candle for August 5, 2025 `/vX/aggs/ESU5?resolution=1day&window_start=2025-08-05` 3. Daily candles from July 1–31, 2025 `/vX/aggs/ESU5?resolution=1day&window_start.gte=2025-07-01&window_start.lte=2025-07-31` 4. 1,000 one-second candles after a specific timestamp `/vX/aggs/ESU5?resolution=1sec&window_start.gt=1751409877000000000&limit=1000` * @param {number} [limit] The number of results to return per page (default=1000, maximum=50000, minimum=1). * @param {string} [windowStartGte] Range by window_start. * @param {string} [windowStartGt] Range by window_start. @@ -25284,6 +32805,141 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa getFuturesTrades(ticker: string, timestamp?: string, sessionEndDate?: string, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, sessionEndDateGte?: string, sessionEndDateGt?: string, sessionEndDateLte?: string, sessionEndDateLt?: string, sort?: GetFuturesTradesSortEnum, options?: RawAxiosRequestConfig): Promise { return localVarFp.getFuturesTrades(ticker, timestamp, sessionEndDate, limit, timestampGte, timestampGt, timestampLte, timestampLt, sessionEndDateGte, sessionEndDateGt, sessionEndDateLte, sessionEndDateLt, sort, options).then((request) => request(axios, basePath)); }, + /** + * Retrieve detailed information about a specific futures contract identified by its ticker. The response includes comprehensive attributes such as active status, trade dates, days to maturity, exchange code, order quantity limits, settlement date, tick sizes, and other key metrics. Users can specify a point-in-time (as_of) to view the contract\'s state on a particular date, supporting informed trading decisions and historical analysis. Use Cases: Contract specification, historical product checks, system integration, trading decision support. + * @summary futures_contracts_v1 API + * @param {string} [date] A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about products for the specified day (default=today). Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [productCode] The unique identifier for the product. + * @param {string} [productCodeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [productCodeGt] Filter greater than the value. + * @param {string} [productCodeGte] Filter greater than or equal to the value. + * @param {string} [productCodeLt] Filter less than the value. + * @param {string} [productCodeLte] Filter less than or equal to the value. + * @param {string} [ticker] The ticker for the contract. + * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickerGt] Filter greater than the value. + * @param {string} [tickerGte] Filter greater than or equal to the value. + * @param {string} [tickerLt] Filter less than the value. + * @param {string} [tickerLte] Filter less than or equal to the value. + * @param {string} [active] The contract is still trading. Value must be \'true\', \'false\', \'1\' or \'0\'. + * @param {string} [type] The type of product, one of \'single\' or \'combo\'. + * @param {string} [typeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [typeGt] Filter greater than the value. + * @param {string} [typeGte] Filter greater than or equal to the value. + * @param {string} [typeLt] Filter less than the value. + * @param {string} [typeLte] Filter less than or equal to the value. + * @param {string} [firstTradeDate] The first date the contract trades. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [firstTradeDateGt] Filter greater than the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [firstTradeDateGte] Filter greater than or equal to the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [firstTradeDateLt] Filter less than the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [firstTradeDateLte] Filter less than or equal to the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastTradeDate] The last date the contract trades. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastTradeDateGt] Filter greater than the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastTradeDateGte] Filter greater than or equal to the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastTradeDateLt] Filter less than the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastTradeDateLte] Filter less than or equal to the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'1000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'product_code\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getFuturesVXContractsNew(date?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, productCode?: string, productCodeAnyOf?: string, productCodeGt?: string, productCodeGte?: string, productCodeLt?: string, productCodeLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, active?: string, type?: string, typeAnyOf?: string, typeGt?: string, typeGte?: string, typeLt?: string, typeLte?: string, firstTradeDate?: string, firstTradeDateGt?: string, firstTradeDateGte?: string, firstTradeDateLt?: string, firstTradeDateLte?: string, lastTradeDate?: string, lastTradeDateGt?: string, lastTradeDateGte?: string, lastTradeDateLt?: string, lastTradeDateLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise { + return localVarFp.getFuturesVXContractsNew(date, dateGt, dateGte, dateLt, dateLte, productCode, productCodeAnyOf, productCodeGt, productCodeGte, productCodeLt, productCodeLte, ticker, tickerAnyOf, tickerGt, tickerGte, tickerLt, tickerLte, active, type, typeAnyOf, typeGt, typeGte, typeLt, typeLte, firstTradeDate, firstTradeDateGt, firstTradeDateGte, firstTradeDateLt, firstTradeDateLte, lastTradeDate, lastTradeDateGt, lastTradeDateGte, lastTradeDateLt, lastTradeDateLte, limit, sort, options).then((request) => request(axios, basePath)); + }, + /** + * US futures exchanges and trading venues including major derivatives exchanges (CME, CBOT, NYMEX, COMEX) and other futures market infrastructure for commodity, financial, and other derivative contract trading. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'999\'. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getFuturesVXExchanges(limit?: number, options?: RawAxiosRequestConfig): Promise { + return localVarFp.getFuturesVXExchanges(limit, options).then((request) => request(axios, basePath)); + }, + /** + * Retrieve detailed information about a single futures product as of a specified date, including its asset class, exchange code, full product name, settlement details, pricing quotation, sector classifications, and unit of measure. Optional parameters such as product type (single or combo) and as_of allow you to capture the product’s state on a specific day, providing essential context for trading decisions and system integrations. Use Cases: Product specification, historical product checks, risk management, trading system integration. + * @summary futures_products_v1 API + * @param {string} [name] The full name of the product. + * @param {string} [nameAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [nameGt] Filter greater than the value. + * @param {string} [nameGte] Filter greater than or equal to the value. + * @param {string} [nameLt] Filter less than the value. + * @param {string} [nameLte] Filter less than or equal to the value. + * @param {string} [productCode] The unique identifier for the product. + * @param {string} [productCodeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [productCodeGt] Filter greater than the value. + * @param {string} [productCodeGte] Filter greater than or equal to the value. + * @param {string} [productCodeLt] Filter less than the value. + * @param {string} [productCodeLte] Filter less than or equal to the value. + * @param {string} [date] A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about products for the specified day (default=today). Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [sector] The sector to which the product belongs. + * @param {string} [sectorAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [sectorGt] Filter greater than the value. + * @param {string} [sectorGte] Filter greater than or equal to the value. + * @param {string} [sectorLt] Filter less than the value. + * @param {string} [sectorLte] Filter less than or equal to the value. + * @param {string} [subSector] The sub-sector to which the product belongs. + * @param {string} [subSectorAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [subSectorGt] Filter greater than the value. + * @param {string} [subSectorGte] Filter greater than or equal to the value. + * @param {string} [subSectorLt] Filter less than the value. + * @param {string} [subSectorLte] Filter less than or equal to the value. + * @param {string} [assetClass] The asset class to which the product belongs. + * @param {string} [assetClassAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [assetClassGt] Filter greater than the value. + * @param {string} [assetClassGte] Filter greater than or equal to the value. + * @param {string} [assetClassLt] Filter less than the value. + * @param {string} [assetClassLte] Filter less than or equal to the value. + * @param {string} [assetSubClass] The asset sub-class to which the product belongs. + * @param {string} [assetSubClassAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [assetSubClassGt] Filter greater than the value. + * @param {string} [assetSubClassGte] Filter greater than or equal to the value. + * @param {string} [assetSubClassLt] Filter less than the value. + * @param {string} [assetSubClassLte] Filter less than or equal to the value. + * @param {string} [type] The type of product, one of \'single\' or \'combo\'. + * @param {string} [typeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [typeGt] Filter greater than the value. + * @param {string} [typeGte] Filter greater than or equal to the value. + * @param {string} [typeLt] Filter less than the value. + * @param {string} [typeLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getFuturesVXProductsNew(name?: string, nameAnyOf?: string, nameGt?: string, nameGte?: string, nameLt?: string, nameLte?: string, productCode?: string, productCodeAnyOf?: string, productCodeGt?: string, productCodeGte?: string, productCodeLt?: string, productCodeLte?: string, date?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, sector?: string, sectorAnyOf?: string, sectorGt?: string, sectorGte?: string, sectorLt?: string, sectorLte?: string, subSector?: string, subSectorAnyOf?: string, subSectorGt?: string, subSectorGte?: string, subSectorLt?: string, subSectorLte?: string, assetClass?: string, assetClassAnyOf?: string, assetClassGt?: string, assetClassGte?: string, assetClassLt?: string, assetClassLte?: string, assetSubClass?: string, assetSubClassAnyOf?: string, assetSubClassGt?: string, assetSubClassGte?: string, assetSubClassLt?: string, assetSubClassLte?: string, type?: string, typeAnyOf?: string, typeGt?: string, typeGte?: string, typeLt?: string, typeLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise { + return localVarFp.getFuturesVXProductsNew(name, nameAnyOf, nameGt, nameGte, nameLt, nameLte, productCode, productCodeAnyOf, productCodeGt, productCodeGte, productCodeLt, productCodeLte, date, dateGt, dateGte, dateLt, dateLte, sector, sectorAnyOf, sectorGt, sectorGte, sectorLt, sectorLte, subSector, subSectorAnyOf, subSectorGt, subSectorGte, subSectorLt, subSectorLte, assetClass, assetClassAnyOf, assetClassGt, assetClassGte, assetClassLt, assetClassLte, assetSubClass, assetSubClassAnyOf, assetSubClassGt, assetSubClassGte, assetSubClassLt, assetSubClassLte, type, typeAnyOf, typeGt, typeGte, typeLt, typeLte, limit, sort, options).then((request) => request(axios, basePath)); + }, + /** + * Retrieve a snapshot of the most recent futures contract data. + * @summary futures_snapshot_v1 API + * @param {string} [productCode] The code for the contracts\' underlying product. + * @param {string} [productCodeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [productCodeGt] Filter greater than the value. + * @param {string} [productCodeGte] Filter greater than or equal to the value. + * @param {string} [productCodeLt] Filter less than the value. + * @param {string} [productCodeLte] Filter less than or equal to the value. + * @param {string} [ticker] The futures contract identifier, including the base symbol and contract expiration (e.g., ESZ24 for the December 2024 S&P 500 E-mini contract). + * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickerGt] Filter greater than the value. + * @param {string} [tickerGte] Filter greater than or equal to the value. + * @param {string} [tickerLt] Filter less than the value. + * @param {string} [tickerLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'ticker\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getFuturesVXSnapshot(productCode?: string, productCodeAnyOf?: string, productCodeGt?: string, productCodeGte?: string, productCodeLt?: string, productCodeLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise { + return localVarFp.getFuturesVXSnapshot(productCode, productCodeAnyOf, productCodeGt, productCodeGte, productCodeLt, productCodeLte, ticker, tickerAnyOf, tickerGt, tickerGte, tickerLt, tickerLte, limit, sort, options).then((request) => request(axios, basePath)); + }, /** * Get the daily open, high, low, and close (OHLC) for the entire cryptocurrency markets. * @summary Grouped Daily (Bars) @@ -25327,7 +32983,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetIndicesAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). - * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. + * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://massive.com/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -25544,7 +33200,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetOptionsAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). - * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. + * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://massive.com/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -25578,7 +33234,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa /** * Get an options contract * @summary Options Contract - * @param {string} optionsTicker Query for a contract by options ticker. You can learn more about the structure of options tickers [here](https://polygon.io/blog/how-to-read-a-stock-options-ticker/). + * @param {string} optionsTicker Query for a contract by options ticker. You can learn more about the structure of options tickers [here](https://massive.com/blog/how-to-read-a-stock-options-ticker/). * @param {string} [asOf] Specify a point in time for the contract as of this date with format YYYY-MM-DD. Defaults to today\'s date. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -25724,6 +33380,15 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa getOptionsTrades(optionsTicker: string, timestamp?: string, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, order?: GetOptionsTradesOrderEnum, limit?: number, sort?: GetOptionsTradesSortEnum, options?: RawAxiosRequestConfig): Promise { return localVarFp.getOptionsTrades(optionsTicker, timestamp, timestampGte, timestampGt, timestampLte, timestampLt, order, limit, sort, options).then((request) => request(axios, basePath)); }, + /** + * US options exchanges and trading venues including traditional options exchanges (CBOE, ISE, etc.), Securities Information Processors (SIP), and other options market infrastructure for derivatives trading. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'999\'. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getOptionsV1Exchanges(limit?: number, options?: RawAxiosRequestConfig): Promise { + return localVarFp.getOptionsV1Exchanges(limit, options).then((request) => request(axios, basePath)); + }, /** * Get the previous day\'s open, high, low, and close (OHLC) for the specified cryptocurrency pair. * @summary Previous Close @@ -25791,7 +33456,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa /** * Get everything needed to visualize the tick-by-tick movement of a list of tickers. * @summary Summaries - * @param {string} [tickerAnyOf] Comma separated list of tickers. This API currently supports Stocks/Equities, Crypto, Options, and Forex. See <a rel=\"nofollow\" target=\"_blank\" href=\"https://polygon.io/docs/stocks/get_v3_reference_tickers\">the tickers endpoint</a> for more details on supported tickers. If no tickers are passed then no results will be returned. Warning: The maximum number of characters allowed in a URL are subject to your technology stack. + * @param {string} [tickerAnyOf] Comma separated list of tickers. This API currently supports Stocks/Equities, Crypto, Options, and Forex. See <a rel=\"nofollow\" target=\"_blank\" href=\"https://massive.com/docs/stocks/get_v3_reference_tickers\">the tickers endpoint</a> for more details on supported tickers. If no tickers are passed then no results will be returned. Warning: The maximum number of characters allowed in a URL are subject to your technology stack. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -25827,7 +33492,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetStocksAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). - * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. + * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://massive.com/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -25856,6 +33521,263 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa getStocksEMA(stockTicker: string, timestamp?: string, timespan?: GetStocksEMATimespanEnum, adjusted?: boolean, window?: number, seriesType?: GetStocksEMASeriesTypeEnum, expandUnderlying?: boolean, order?: GetStocksEMAOrderEnum, limit?: number, timestampGte?: string, timestampGt?: string, timestampLte?: string, timestampLt?: string, options?: RawAxiosRequestConfig): Promise { return localVarFp.getStocksEMA(stockTicker, timestamp, timespan, adjusted, window, seriesType, expandUnderlying, order, limit, timestampGte, timestampGt, timestampLte, timestampLt, options).then((request) => request(axios, basePath)); }, + /** + * A comprehensive financial dataset containing quarterly and annual balance sheet data for public companies. Includes detailed asset, liability, and equity positions representing the company\'s financial position at specific points in time. Balance sheet data represents point-in-time snapshots rather than cumulative flows, showing what the company owns, owes, and shareholders\' equity as of each period end date. + * @param {string} [cik] The company\'s Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company\'s CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup). + * @param {string} [cikAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [cikGt] Filter greater than the value. + * @param {string} [cikGte] Filter greater than or equal to the value. + * @param {string} [cikLt] Filter less than the value. + * @param {string} [cikLte] Filter less than or equal to the value. + * @param {string} [tickers] Filter for arrays that contain the value. + * @param {string} [tickersAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickersAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [periodEnd] The last date of the reporting period, representing the specific point in time when the balance sheet snapshot was taken. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDate] The date when the financial statement was filed with the SEC. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {number} [fiscalYear] The fiscal year for the reporting period. Value must be a floating point number. + * @param {number} [fiscalYearGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [fiscalYearGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalYearLt] Filter less than the value. Value must be a floating point number. + * @param {number} [fiscalYearLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalQuarter] The fiscal quarter number (1, 2, 3, or 4) for the reporting period. Value must be a floating point number. + * @param {number} [fiscalQuarterGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [fiscalQuarterGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalQuarterLt] Filter less than the value. Value must be a floating point number. + * @param {number} [fiscalQuarterLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {string} [timeframe] The reporting period type. Possible values include: quarterly, annual. + * @param {string} [timeframeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [timeframeGt] Filter greater than the value. + * @param {string} [timeframeGte] Filter greater than or equal to the value. + * @param {string} [timeframeLt] Filter less than the value. + * @param {string} [timeframeLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'period_end\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getStocksFinancialsV1BalanceSheets(cik?: string, cikAnyOf?: string, cikGt?: string, cikGte?: string, cikLt?: string, cikLte?: string, tickers?: string, tickersAllOf?: string, tickersAnyOf?: string, periodEnd?: string, periodEndGt?: string, periodEndGte?: string, periodEndLt?: string, periodEndLte?: string, filingDate?: string, filingDateGt?: string, filingDateGte?: string, filingDateLt?: string, filingDateLte?: string, fiscalYear?: number, fiscalYearGt?: number, fiscalYearGte?: number, fiscalYearLt?: number, fiscalYearLte?: number, fiscalQuarter?: number, fiscalQuarterGt?: number, fiscalQuarterGte?: number, fiscalQuarterLt?: number, fiscalQuarterLte?: number, timeframe?: string, timeframeAnyOf?: string, timeframeGt?: string, timeframeGte?: string, timeframeLt?: string, timeframeLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise { + return localVarFp.getStocksFinancialsV1BalanceSheets(cik, cikAnyOf, cikGt, cikGte, cikLt, cikLte, tickers, tickersAllOf, tickersAnyOf, periodEnd, periodEndGt, periodEndGte, periodEndLt, periodEndLte, filingDate, filingDateGt, filingDateGte, filingDateLt, filingDateLte, fiscalYear, fiscalYearGt, fiscalYearGte, fiscalYearLt, fiscalYearLte, fiscalQuarter, fiscalQuarterGt, fiscalQuarterGte, fiscalQuarterLt, fiscalQuarterLte, timeframe, timeframeAnyOf, timeframeGt, timeframeGte, timeframeLt, timeframeLte, limit, sort, options).then((request) => request(axios, basePath)); + }, + /** + * A comprehensive financial dataset containing quarterly, annual, and trailing twelve-month cash flow statement data for public companies. Includes detailed operating, investing, and financing cash flows with proper TTM calculations that sum all cash flow components over four quarters. TTM records are validated to ensure exactly four distinct quarters spanning 250-400 days for accurate trailing twelve-month cash flow analysis. + * @param {string} [cik] The company\'s Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company’s CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup). + * @param {string} [cikAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [cikGt] Filter greater than the value. + * @param {string} [cikGte] Filter greater than or equal to the value. + * @param {string} [cikLt] Filter less than the value. + * @param {string} [cikLte] Filter less than or equal to the value. + * @param {string} [periodEnd] The last date of the reporting period (formatted as YYYY-MM-DD). Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDate] The date when the financial statement was filed with the SEC. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [tickers] Filter for arrays that contain the value. + * @param {string} [tickersAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickersAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {number} [fiscalYear] The fiscal year for the reporting period. Value must be a floating point number. + * @param {number} [fiscalYearGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [fiscalYearGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalYearLt] Filter less than the value. Value must be a floating point number. + * @param {number} [fiscalYearLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalQuarter] The fiscal quarter number (1, 2, 3, or 4) for the reporting period. Value must be a floating point number. + * @param {number} [fiscalQuarterGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [fiscalQuarterGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalQuarterLt] Filter less than the value. Value must be a floating point number. + * @param {number} [fiscalQuarterLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {string} [timeframe] The reporting period type. Possible values include: quarterly, annual, trailing_twelve_months. + * @param {string} [timeframeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [timeframeGt] Filter greater than the value. + * @param {string} [timeframeGte] Filter greater than or equal to the value. + * @param {string} [timeframeLt] Filter less than the value. + * @param {string} [timeframeLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'period_end\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getStocksFinancialsV1CashFlowStatements(cik?: string, cikAnyOf?: string, cikGt?: string, cikGte?: string, cikLt?: string, cikLte?: string, periodEnd?: string, periodEndGt?: string, periodEndGte?: string, periodEndLt?: string, periodEndLte?: string, filingDate?: string, filingDateGt?: string, filingDateGte?: string, filingDateLt?: string, filingDateLte?: string, tickers?: string, tickersAllOf?: string, tickersAnyOf?: string, fiscalYear?: number, fiscalYearGt?: number, fiscalYearGte?: number, fiscalYearLt?: number, fiscalYearLte?: number, fiscalQuarter?: number, fiscalQuarterGt?: number, fiscalQuarterGte?: number, fiscalQuarterLt?: number, fiscalQuarterLte?: number, timeframe?: string, timeframeAnyOf?: string, timeframeGt?: string, timeframeGte?: string, timeframeLt?: string, timeframeLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise { + return localVarFp.getStocksFinancialsV1CashFlowStatements(cik, cikAnyOf, cikGt, cikGte, cikLt, cikLte, periodEnd, periodEndGt, periodEndGte, periodEndLt, periodEndLte, filingDate, filingDateGt, filingDateGte, filingDateLt, filingDateLte, tickers, tickersAllOf, tickersAnyOf, fiscalYear, fiscalYearGt, fiscalYearGte, fiscalYearLt, fiscalYearLte, fiscalQuarter, fiscalQuarterGt, fiscalQuarterGte, fiscalQuarterLt, fiscalQuarterLte, timeframe, timeframeAnyOf, timeframeGt, timeframeGte, timeframeLt, timeframeLte, limit, sort, options).then((request) => request(axios, basePath)); + }, + /** + * A comprehensive database of income statement financial data for public companies, including key metrics such as revenue, expenses, and net income for various reporting periods. + * @param {string} [cik] The company\'s Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company’s CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup). + * @param {string} [cikAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [cikGt] Filter greater than the value. + * @param {string} [cikGte] Filter greater than or equal to the value. + * @param {string} [cikLt] Filter less than the value. + * @param {string} [cikLte] Filter less than or equal to the value. + * @param {string} [tickers] Filter for arrays that contain the value. + * @param {string} [tickersAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickersAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [periodEnd] The last date of the reporting period (formatted as YYYY-MM-DD). Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDate] The date when the financial statement was filed with the SEC. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {number} [fiscalYear] The fiscal year for the reporting period. Value must be a floating point number. + * @param {number} [fiscalYearGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [fiscalYearGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalYearLt] Filter less than the value. Value must be a floating point number. + * @param {number} [fiscalYearLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalQuarter] The fiscal quarter number (1, 2, 3, or 4) for the reporting period. Value must be a floating point number. + * @param {number} [fiscalQuarterGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [fiscalQuarterGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalQuarterLt] Filter less than the value. Value must be a floating point number. + * @param {number} [fiscalQuarterLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {string} [timeframe] The reporting period type. Possible values include: quarterly, annual, trailing_twelve_months. + * @param {string} [timeframeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [timeframeGt] Filter greater than the value. + * @param {string} [timeframeGte] Filter greater than or equal to the value. + * @param {string} [timeframeLt] Filter less than the value. + * @param {string} [timeframeLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'period_end\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getStocksFinancialsV1IncomeStatements(cik?: string, cikAnyOf?: string, cikGt?: string, cikGte?: string, cikLt?: string, cikLte?: string, tickers?: string, tickersAllOf?: string, tickersAnyOf?: string, periodEnd?: string, periodEndGt?: string, periodEndGte?: string, periodEndLt?: string, periodEndLte?: string, filingDate?: string, filingDateGt?: string, filingDateGte?: string, filingDateLt?: string, filingDateLte?: string, fiscalYear?: number, fiscalYearGt?: number, fiscalYearGte?: number, fiscalYearLt?: number, fiscalYearLte?: number, fiscalQuarter?: number, fiscalQuarterGt?: number, fiscalQuarterGte?: number, fiscalQuarterLt?: number, fiscalQuarterLte?: number, timeframe?: string, timeframeAnyOf?: string, timeframeGt?: string, timeframeGte?: string, timeframeLt?: string, timeframeLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise { + return localVarFp.getStocksFinancialsV1IncomeStatements(cik, cikAnyOf, cikGt, cikGte, cikLt, cikLte, tickers, tickersAllOf, tickersAnyOf, periodEnd, periodEndGt, periodEndGte, periodEndLt, periodEndLte, filingDate, filingDateGt, filingDateGte, filingDateLt, filingDateLte, fiscalYear, fiscalYearGt, fiscalYearGte, fiscalYearLt, fiscalYearLte, fiscalQuarter, fiscalQuarterGt, fiscalQuarterGte, fiscalQuarterLt, fiscalQuarterLte, timeframe, timeframeAnyOf, timeframeGt, timeframeGte, timeframeLt, timeframeLte, limit, sort, options).then((request) => request(axios, basePath)); + }, + /** + * A comprehensive financial ratios dataset providing key valuation, profitability, liquidity, and leverage metrics for public companies. Combines data from income statements, balance sheets, and cash flow statements with daily stock prices to calculate ratios on a daily basis. Uses trailing twelve months (TTM) data for income/cash flow metrics and quarterly data for balance sheet items. Fundamental data updates are applied starting from each filing\'s period end date. Market cap calculations use point-in-time shares outstanding for historical accuracy. + * @param {string} [ticker] Stock ticker symbol for the company. + * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickerGt] Filter greater than the value. + * @param {string} [tickerGte] Filter greater than or equal to the value. + * @param {string} [tickerLt] Filter less than the value. + * @param {string} [tickerLte] Filter less than or equal to the value. + * @param {string} [cik] Central Index Key (CIK) number assigned by the SEC to identify the company. + * @param {string} [cikAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [cikGt] Filter greater than the value. + * @param {string} [cikGte] Filter greater than or equal to the value. + * @param {string} [cikLt] Filter less than the value. + * @param {string} [cikLte] Filter less than or equal to the value. + * @param {number} [price] Stock price used in ratio calculations, typically the closing price for the given date. Value must be a floating point number. + * @param {number} [priceGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [priceGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [priceLt] Filter less than the value. Value must be a floating point number. + * @param {number} [priceLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [averageVolume] Average trading volume over the last 30 trading days, providing context for liquidity. Value must be a floating point number. + * @param {number} [averageVolumeGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [averageVolumeGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [averageVolumeLt] Filter less than the value. Value must be a floating point number. + * @param {number} [averageVolumeLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [marketCap] Market capitalization, calculated as stock price multiplied by total shares outstanding. Value must be a floating point number. + * @param {number} [marketCapGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [marketCapGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [marketCapLt] Filter less than the value. Value must be a floating point number. + * @param {number} [marketCapLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [earningsPerShare] Earnings per share, calculated as net income available to common shareholders divided by weighted shares outstanding. Value must be a floating point number. + * @param {number} [earningsPerShareGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [earningsPerShareGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [earningsPerShareLt] Filter less than the value. Value must be a floating point number. + * @param {number} [earningsPerShareLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [priceToEarnings] Price-to-earnings ratio, calculated as stock price divided by earnings per share. Only calculated when earnings per share is positive. Value must be a floating point number. + * @param {number} [priceToEarningsGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [priceToEarningsGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [priceToEarningsLt] Filter less than the value. Value must be a floating point number. + * @param {number} [priceToEarningsLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [priceToBook] Price-to-book ratio, calculated as stock price divided by book value per share, comparing market value to book value. Value must be a floating point number. + * @param {number} [priceToBookGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [priceToBookGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [priceToBookLt] Filter less than the value. Value must be a floating point number. + * @param {number} [priceToBookLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [priceToSales] Price-to-sales ratio, calculated as stock price divided by revenue per share, measuring valuation relative to sales. Value must be a floating point number. + * @param {number} [priceToSalesGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [priceToSalesGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [priceToSalesLt] Filter less than the value. Value must be a floating point number. + * @param {number} [priceToSalesLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [priceToCashFlow] Price-to-cash-flow ratio, calculated as stock price divided by operating cash flow per share. Only calculated when operating cash flow per share is positive. Value must be a floating point number. + * @param {number} [priceToCashFlowGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [priceToCashFlowGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [priceToCashFlowLt] Filter less than the value. Value must be a floating point number. + * @param {number} [priceToCashFlowLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [priceToFreeCashFlow] Price-to-free-cash-flow ratio, calculated as stock price divided by free cash flow per share. Only calculated when free cash flow per share is positive. Value must be a floating point number. + * @param {number} [priceToFreeCashFlowGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [priceToFreeCashFlowGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [priceToFreeCashFlowLt] Filter less than the value. Value must be a floating point number. + * @param {number} [priceToFreeCashFlowLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [dividendYield] Dividend yield, calculated as annual dividends per share divided by stock price, measuring the income return on investment. Value must be a floating point number. + * @param {number} [dividendYieldGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [dividendYieldGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [dividendYieldLt] Filter less than the value. Value must be a floating point number. + * @param {number} [dividendYieldLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [returnOnAssets] Return on assets ratio, calculated as net income divided by total assets, measuring how efficiently a company uses its assets to generate profit. Value must be a floating point number. + * @param {number} [returnOnAssetsGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [returnOnAssetsGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [returnOnAssetsLt] Filter less than the value. Value must be a floating point number. + * @param {number} [returnOnAssetsLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [returnOnEquity] Return on equity ratio, calculated as net income divided by total shareholders\' equity, measuring profitability relative to shareholders\' equity. Value must be a floating point number. + * @param {number} [returnOnEquityGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [returnOnEquityGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [returnOnEquityLt] Filter less than the value. Value must be a floating point number. + * @param {number} [returnOnEquityLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [debtToEquity] Debt-to-equity ratio, calculated as total debt (current debt plus long-term debt) divided by total shareholders\' equity, measuring financial leverage. Value must be a floating point number. + * @param {number} [debtToEquityGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [debtToEquityGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [debtToEquityLt] Filter less than the value. Value must be a floating point number. + * @param {number} [debtToEquityLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [current] Current ratio, calculated as total current assets divided by total current liabilities, measuring short-term liquidity. Value must be a floating point number. + * @param {number} [currentGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [currentGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [currentLt] Filter less than the value. Value must be a floating point number. + * @param {number} [currentLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quick] Quick ratio (acid-test ratio), calculated as (current assets minus inventories) divided by current liabilities, measuring immediate liquidity. Value must be a floating point number. + * @param {number} [quickGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quickGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quickLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quickLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [cash] Cash ratio, calculated as cash and cash equivalents divided by current liabilities, measuring the most liquid form of liquidity coverage. Value must be a floating point number. + * @param {number} [cashGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [cashGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [cashLt] Filter less than the value. Value must be a floating point number. + * @param {number} [cashLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [evToSales] Enterprise value to sales ratio, calculated as enterprise value divided by revenue, measuring company valuation relative to sales. Value must be a floating point number. + * @param {number} [evToSalesGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [evToSalesGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [evToSalesLt] Filter less than the value. Value must be a floating point number. + * @param {number} [evToSalesLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [evToEbitda] Enterprise value to EBITDA ratio, calculated as enterprise value divided by EBITDA, measuring company valuation relative to earnings before interest, taxes, depreciation, and amortization. Value must be a floating point number. + * @param {number} [evToEbitdaGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [evToEbitdaGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [evToEbitdaLt] Filter less than the value. Value must be a floating point number. + * @param {number} [evToEbitdaLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [enterpriseValue] Enterprise value, calculated as market capitalization plus total debt minus cash and cash equivalents, representing total company value. Value must be a floating point number. + * @param {number} [enterpriseValueGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [enterpriseValueGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [enterpriseValueLt] Filter less than the value. Value must be a floating point number. + * @param {number} [enterpriseValueLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [freeCashFlow] Free cash flow, calculated as operating cash flow minus capital expenditures (purchase of property, plant, and equipment). Value must be a floating point number. + * @param {number} [freeCashFlowGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [freeCashFlowGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [freeCashFlowLt] Filter less than the value. Value must be a floating point number. + * @param {number} [freeCashFlowLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'ticker\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getStocksFinancialsV1Ratios(ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, cik?: string, cikAnyOf?: string, cikGt?: string, cikGte?: string, cikLt?: string, cikLte?: string, price?: number, priceGt?: number, priceGte?: number, priceLt?: number, priceLte?: number, averageVolume?: number, averageVolumeGt?: number, averageVolumeGte?: number, averageVolumeLt?: number, averageVolumeLte?: number, marketCap?: number, marketCapGt?: number, marketCapGte?: number, marketCapLt?: number, marketCapLte?: number, earningsPerShare?: number, earningsPerShareGt?: number, earningsPerShareGte?: number, earningsPerShareLt?: number, earningsPerShareLte?: number, priceToEarnings?: number, priceToEarningsGt?: number, priceToEarningsGte?: number, priceToEarningsLt?: number, priceToEarningsLte?: number, priceToBook?: number, priceToBookGt?: number, priceToBookGte?: number, priceToBookLt?: number, priceToBookLte?: number, priceToSales?: number, priceToSalesGt?: number, priceToSalesGte?: number, priceToSalesLt?: number, priceToSalesLte?: number, priceToCashFlow?: number, priceToCashFlowGt?: number, priceToCashFlowGte?: number, priceToCashFlowLt?: number, priceToCashFlowLte?: number, priceToFreeCashFlow?: number, priceToFreeCashFlowGt?: number, priceToFreeCashFlowGte?: number, priceToFreeCashFlowLt?: number, priceToFreeCashFlowLte?: number, dividendYield?: number, dividendYieldGt?: number, dividendYieldGte?: number, dividendYieldLt?: number, dividendYieldLte?: number, returnOnAssets?: number, returnOnAssetsGt?: number, returnOnAssetsGte?: number, returnOnAssetsLt?: number, returnOnAssetsLte?: number, returnOnEquity?: number, returnOnEquityGt?: number, returnOnEquityGte?: number, returnOnEquityLt?: number, returnOnEquityLte?: number, debtToEquity?: number, debtToEquityGt?: number, debtToEquityGte?: number, debtToEquityLt?: number, debtToEquityLte?: number, current?: number, currentGt?: number, currentGte?: number, currentLt?: number, currentLte?: number, quick?: number, quickGt?: number, quickGte?: number, quickLt?: number, quickLte?: number, cash?: number, cashGt?: number, cashGte?: number, cashLt?: number, cashLte?: number, evToSales?: number, evToSalesGt?: number, evToSalesGte?: number, evToSalesLt?: number, evToSalesLte?: number, evToEbitda?: number, evToEbitdaGt?: number, evToEbitdaGte?: number, evToEbitdaLt?: number, evToEbitdaLte?: number, enterpriseValue?: number, enterpriseValueGt?: number, enterpriseValueGte?: number, enterpriseValueLt?: number, enterpriseValueLte?: number, freeCashFlow?: number, freeCashFlowGt?: number, freeCashFlowGte?: number, freeCashFlowLt?: number, freeCashFlowLte?: number, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise { + return localVarFp.getStocksFinancialsV1Ratios(ticker, tickerAnyOf, tickerGt, tickerGte, tickerLt, tickerLte, cik, cikAnyOf, cikGt, cikGte, cikLt, cikLte, price, priceGt, priceGte, priceLt, priceLte, averageVolume, averageVolumeGt, averageVolumeGte, averageVolumeLt, averageVolumeLte, marketCap, marketCapGt, marketCapGte, marketCapLt, marketCapLte, earningsPerShare, earningsPerShareGt, earningsPerShareGte, earningsPerShareLt, earningsPerShareLte, priceToEarnings, priceToEarningsGt, priceToEarningsGte, priceToEarningsLt, priceToEarningsLte, priceToBook, priceToBookGt, priceToBookGte, priceToBookLt, priceToBookLte, priceToSales, priceToSalesGt, priceToSalesGte, priceToSalesLt, priceToSalesLte, priceToCashFlow, priceToCashFlowGt, priceToCashFlowGte, priceToCashFlowLt, priceToCashFlowLte, priceToFreeCashFlow, priceToFreeCashFlowGt, priceToFreeCashFlowGte, priceToFreeCashFlowLt, priceToFreeCashFlowLte, dividendYield, dividendYieldGt, dividendYieldGte, dividendYieldLt, dividendYieldLte, returnOnAssets, returnOnAssetsGt, returnOnAssetsGte, returnOnAssetsLt, returnOnAssetsLte, returnOnEquity, returnOnEquityGt, returnOnEquityGte, returnOnEquityLt, returnOnEquityLte, debtToEquity, debtToEquityGt, debtToEquityGte, debtToEquityLt, debtToEquityLte, current, currentGt, currentGte, currentLt, currentLte, quick, quickGt, quickGte, quickLt, quickLte, cash, cashGt, cashGte, cashLt, cashLte, evToSales, evToSalesGt, evToSalesGte, evToSalesLt, evToSalesLte, evToEbitda, evToEbitdaGt, evToEbitdaGte, evToEbitdaLt, evToEbitdaLte, enterpriseValue, enterpriseValueGt, enterpriseValueGte, enterpriseValueLt, enterpriseValueLte, freeCashFlow, freeCashFlowGt, freeCashFlowGte, freeCashFlowLt, freeCashFlowLte, limit, sort, options).then((request) => request(axios, basePath)); + }, /** * Get moving average convergence/divergence (MACD) data for a ticker symbol over a given time range. * @summary Moving Average Convergence/Divergence (MACD) @@ -26005,7 +33927,16 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa return localVarFp.getStocksTrades(stockTicker, timestamp, timestampGte, timestampGt, timestampLte, timestampLt, order, limit, sort, options).then((request) => request(axios, basePath)); }, /** - * + * US stock exchanges, trading venues, and reporting facilities including exchanges (NYSE, Nasdaq), Trade Reporting Facilities (TRF), Securities Information Processors (SIP), and OTC Reporting Facilities (ORF) for equity trading. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'999\'. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getStocksV1Exchanges(limit?: number, options?: RawAxiosRequestConfig): Promise { + return localVarFp.getStocksV1Exchanges(limit, options).then((request) => request(axios, basePath)); + }, + /** + * Comprehensive FINRA short interest data that tracks the short selling metrics for securities on a specific settlement date. * @param {string} [ticker] The primary ticker symbol for the stock. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. @@ -26039,7 +33970,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa return localVarFp.getStocksV1ShortInterest(ticker, tickerAnyOf, tickerGt, tickerGte, tickerLt, tickerLte, daysToCover, daysToCoverAnyOf, daysToCoverGt, daysToCoverGte, daysToCoverLt, daysToCoverLte, settlementDate, settlementDateAnyOf, settlementDateGt, settlementDateGte, settlementDateLt, settlementDateLte, avgDailyVolume, avgDailyVolumeAnyOf, avgDailyVolumeGt, avgDailyVolumeGte, avgDailyVolumeLt, avgDailyVolumeLte, limit, sort, options).then((request) => request(axios, basePath)); }, /** - * + * Contains short selling volume for different stock tickers, capturing total trading volume, short sale details, and breakdown by different trading platforms. * @param {string} [ticker] The primary ticker symbol for the stock. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. @@ -26073,7 +34004,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa return localVarFp.getStocksV1ShortVolume(ticker, tickerAnyOf, tickerGt, tickerGte, tickerLt, tickerLte, date, dateAnyOf, dateGt, dateGte, dateLt, dateLte, shortVolumeRatio, shortVolumeRatioAnyOf, shortVolumeRatioGt, shortVolumeRatioGte, shortVolumeRatioLt, shortVolumeRatioLte, totalVolume, totalVolumeAnyOf, totalVolumeGt, totalVolumeGte, totalVolumeLt, totalVolumeLte, limit, sort, options).then((request) => request(axios, basePath)); }, /** - * Get a single ticker supported by Polygon.io. This response will have detailed information about the ticker and the company behind it. + * Get a single ticker supported by Massive.com. This response will have detailed information about the ticker and the company behind it. * @summary Ticker Details v3 * @param {string} ticker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} [date] Specify a point in time to get information about the ticker available on that date. When retrieving information from SEC filings, we compare this date with the period of report date on the SEC filing. For example, consider an SEC filing submitted by AAPL on 2019-07-31, with a period of report date ending on 2019-06-29. That means that the filing was submitted on 2019-07-31, but the filing was created based on information from 2019-06-29. If you were to query for AAPL details on 2019-06-29, the ticker details would include information from the SEC filing. Defaults to the most recent available date. @@ -26084,7 +34015,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa return localVarFp.getTicker(ticker, date, options).then((request) => request(axios, basePath)); }, /** - * + * Contains corporate events and announcements for publicly traded companies, including earnings releases, conferences, dividends, and business updates sourced from TMX. * @param {string} [date] Scheduled date of the corporate event, formatted as YYYY-MM-DD. * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. @@ -26122,7 +34053,6 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {string} [tradingVenueLt] Filter less than the value. * @param {string} [tradingVenueLte] Filter less than or equal to the value. * @param {number} [tmxCompanyId] Unique numeric identifier for the company used by TMX. Value must be an integer. - * @param {string} [tmxCompanyIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [tmxCompanyIdGt] Filter greater than the value. Value must be an integer. * @param {number} [tmxCompanyIdGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [tmxCompanyIdLt] Filter less than the value. Value must be an integer. @@ -26138,11 +34068,11 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getTmxV1CorporateEvents(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, type?: string, typeAnyOf?: string, typeGt?: string, typeGte?: string, typeLt?: string, typeLte?: string, status?: string, statusAnyOf?: string, statusGt?: string, statusGte?: string, statusLt?: string, statusLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, isin?: string, isinAnyOf?: string, isinGt?: string, isinGte?: string, isinLt?: string, isinLte?: string, tradingVenue?: string, tradingVenueAnyOf?: string, tradingVenueGt?: string, tradingVenueGte?: string, tradingVenueLt?: string, tradingVenueLte?: string, tmxCompanyId?: number, tmxCompanyIdAnyOf?: string, tmxCompanyIdGt?: number, tmxCompanyIdGte?: number, tmxCompanyIdLt?: number, tmxCompanyIdLte?: number, tmxRecordId?: string, tmxRecordIdAnyOf?: string, tmxRecordIdGt?: string, tmxRecordIdGte?: string, tmxRecordIdLt?: string, tmxRecordIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise { - return localVarFp.getTmxV1CorporateEvents(date, dateAnyOf, dateGt, dateGte, dateLt, dateLte, type, typeAnyOf, typeGt, typeGte, typeLt, typeLte, status, statusAnyOf, statusGt, statusGte, statusLt, statusLte, ticker, tickerAnyOf, tickerGt, tickerGte, tickerLt, tickerLte, isin, isinAnyOf, isinGt, isinGte, isinLt, isinLte, tradingVenue, tradingVenueAnyOf, tradingVenueGt, tradingVenueGte, tradingVenueLt, tradingVenueLte, tmxCompanyId, tmxCompanyIdAnyOf, tmxCompanyIdGt, tmxCompanyIdGte, tmxCompanyIdLt, tmxCompanyIdLte, tmxRecordId, tmxRecordIdAnyOf, tmxRecordIdGt, tmxRecordIdGte, tmxRecordIdLt, tmxRecordIdLte, limit, sort, options).then((request) => request(axios, basePath)); + getTmxV1CorporateEvents(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, type?: string, typeAnyOf?: string, typeGt?: string, typeGte?: string, typeLt?: string, typeLte?: string, status?: string, statusAnyOf?: string, statusGt?: string, statusGte?: string, statusLt?: string, statusLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, isin?: string, isinAnyOf?: string, isinGt?: string, isinGte?: string, isinLt?: string, isinLte?: string, tradingVenue?: string, tradingVenueAnyOf?: string, tradingVenueGt?: string, tradingVenueGte?: string, tradingVenueLt?: string, tradingVenueLte?: string, tmxCompanyId?: number, tmxCompanyIdGt?: number, tmxCompanyIdGte?: number, tmxCompanyIdLt?: number, tmxCompanyIdLte?: number, tmxRecordId?: string, tmxRecordIdAnyOf?: string, tmxRecordIdGt?: string, tmxRecordIdGte?: string, tmxRecordIdLt?: string, tmxRecordIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig): Promise { + return localVarFp.getTmxV1CorporateEvents(date, dateAnyOf, dateGt, dateGte, dateLt, dateLte, type, typeAnyOf, typeGt, typeGte, typeLt, typeLte, status, statusAnyOf, statusGt, statusGte, statusLt, statusLte, ticker, tickerAnyOf, tickerGt, tickerGte, tickerLt, tickerLte, isin, isinAnyOf, isinGt, isinGte, isinLt, isinLte, tradingVenue, tradingVenueAnyOf, tradingVenueGt, tradingVenueGte, tradingVenueLt, tradingVenueLte, tmxCompanyId, tmxCompanyIdGt, tmxCompanyIdGte, tmxCompanyIdLt, tmxCompanyIdLte, tmxRecordId, tmxRecordIdAnyOf, tmxRecordIdGt, tmxRecordIdGte, tmxRecordIdLt, tmxRecordIdLte, limit, sort, options).then((request) => request(axios, basePath)); }, /** - * List all conditions that Polygon.io uses. + * List all conditions that Massive.com uses. * @summary Conditions * @param {ListConditionsAssetClassEnum} [assetClass] Filter for conditions within a given asset class. * @param {ListConditionsDataTypeEnum} [dataType] Filter by data type. @@ -26202,7 +34132,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa return localVarFp.listDividends(ticker, exDividendDate, recordDate, declarationDate, payDate, frequency, cashAmount, dividendType, tickerGte, tickerGt, tickerLte, tickerLt, exDividendDateGte, exDividendDateGt, exDividendDateLte, exDividendDateLt, recordDateGte, recordDateGt, recordDateLte, recordDateLt, declarationDateGte, declarationDateGt, declarationDateLte, declarationDateLt, payDateGte, payDateGt, payDateLte, payDateLt, cashAmountGte, cashAmountGt, cashAmountLte, cashAmountLt, order, limit, sort, options).then((request) => request(axios, basePath)); }, /** - * List all exchanges that Polygon.io knows about. + * List all exchanges that Massive.com knows about. * @summary Exchanges * @param {ListExchangesAssetClassEnum} [assetClass] Filter by asset class. * @param {ListExchangesLocaleEnum} [locale] Filter by locale. @@ -26288,7 +34218,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa * Query for historical options contracts. This provides both active and expired options contracts. * @summary Options Contracts * @param {string} [underlyingTicker] Query for contracts relating to an underlying stock ticker. - * @param {string} [ticker] This parameter has been deprecated. To search by specific options ticker, use the Options Contract endpoint [here](https://polygon.io/docs/options/get_v3_reference_options_contracts__options_ticker). + * @param {string} [ticker] This parameter has been deprecated. To search by specific options ticker, use the Options Contract endpoint [here](https://massive.com/docs/options/get_v3_reference_options_contracts__options_ticker). * @param {ListOptionsContractsContractTypeEnum} [contractType] Query by the type of contract. * @param {string} [expirationDate] Query by contract expiration with date format YYYY-MM-DD. * @param {string} [asOf] Specify a point in time for contracts as of this date with format YYYY-MM-DD. Defaults to today\'s date. @@ -26339,7 +34269,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa return localVarFp.listStockSplits(ticker, executionDate, reverseSplit, tickerGte, tickerGt, tickerLte, tickerLt, executionDateGte, executionDateGt, executionDateLte, executionDateLt, order, limit, sort, options).then((request) => request(axios, basePath)); }, /** - * List all ticker types that Polygon.io has. + * List all ticker types that Massive.com has. * @summary Ticker Types * @param {ListTickerTypesAssetClassEnum} [assetClass] Filter by asset class. * @param {ListTickerTypesLocaleEnum} [locale] Filter by locale. @@ -26350,10 +34280,10 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa return localVarFp.listTickerTypes(assetClass, locale, options).then((request) => request(axios, basePath)); }, /** - * Query all ticker symbols which are supported by Polygon.io. This API currently includes Stocks/Equities, Indices, Forex, and Crypto. + * Query all ticker symbols which are supported by Massive.com. This API currently includes Stocks/Equities, Indices, Forex, and Crypto. * @summary Tickers * @param {string} [ticker] Specify a ticker symbol. Defaults to empty string which queries all tickers. - * @param {ListTickersTypeEnum} [type] Specify the type of the tickers. Find the types that we support via our [Ticker Types API](https://polygon.io/docs/stocks/get_v3_reference_tickers_types). Defaults to empty string which queries all types. + * @param {ListTickersTypeEnum} [type] Specify the type of the tickers. Find the types that we support via our [Ticker Types API](https://massive.com/docs/stocks/get_v3_reference_tickers_types). Defaults to empty string which queries all types. * @param {ListTickersMarketEnum} [market] Filter by market type. By default all markets are included. * @param {string} [exchange] Specify the asset\'s primary exchange Market Identifier Code (MIC) according to [ISO 10383](https://www.iso20022.org/market-identifier-codes). Defaults to empty string which queries all exchanges. * @param {string} [cusip] Specify the CUSIP code of the asset you want to search for. Find more information about CUSIP codes [at their website](https://www.cusip.com/identifiers.html#/CUSIP). Defaults to empty string which queries all CUSIPs. Note: Although you can query by CUSIP, due to legal reasons we do not return the CUSIP in the response. @@ -26556,6 +34486,7 @@ export class DefaultApi extends BaseAPI { * A comprehensive financial consensus ratings table that aggregates analyst recommendations and price targets for individual stock tickers, capturing detailed rating breakdowns and statistical insights. * @param {string} ticker The requested ticker. * @param {string} [date] The publication date of the news article. + * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. * @param {string} [dateGte] Filter greater than or equal to the value. * @param {string} [dateLt] Filter less than the value. @@ -26565,8 +34496,8 @@ export class DefaultApi extends BaseAPI { * @throws {RequiredError} * @memberof DefaultApi */ - public getBenzingaV1ConsensusRatings(ticker: string, date?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, options?: RawAxiosRequestConfig) { - return DefaultApiFp(this.configuration).getBenzingaV1ConsensusRatings(ticker, date, dateGt, dateGte, dateLt, dateLte, limit, options).then((request) => request(this.axios, this.basePath)); + public getBenzingaV1ConsensusRatings(ticker: string, date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, limit?: number, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).getBenzingaV1ConsensusRatings(ticker, date, dateAnyOf, dateGt, dateGte, dateLt, dateLte, limit, options).then((request) => request(this.axios, this.basePath)); } /** @@ -26589,12 +34520,12 @@ export class DefaultApi extends BaseAPI { * @param {number} [importanceGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [importanceLt] Filter less than the value. Value must be an integer. * @param {number} [importanceLte] Filter less than or equal to the value. Value must be an integer. - * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system. - * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [lastUpdatedGt] Filter greater than the value. - * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. - * @param {string} [lastUpdatedLt] Filter less than the value. - * @param {string} [lastUpdatedLte] Filter less than or equal to the value. + * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the record was last updated in the system. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedGt] Filter greater than the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedLt] Filter less than the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedLte] Filter less than or equal to the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. * @param {string} [dateStatus] Indicates whether the date of the earnings report has been confirmed. Possible values include: projected, confirmed. * @param {string} [dateStatusAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateStatusGt] Filter greater than the value. @@ -26626,7 +34557,7 @@ export class DefaultApi extends BaseAPI { * @param {string} [fiscalPeriodLt] Filter less than the value. * @param {string} [fiscalPeriodLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. - * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'last_updated\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi @@ -26761,17 +34692,15 @@ export class DefaultApi extends BaseAPI { * @param {string} [tickerLt] Filter less than the value. * @param {string} [tickerLte] Filter less than or equal to the value. * @param {number} [importance] A subjective indicator of the importance of the earnings event, on a scale from 0 (lowest) to 5 (highest). Value must be an integer. - * @param {string} [importanceAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [importanceGt] Filter greater than the value. Value must be an integer. * @param {number} [importanceGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [importanceLt] Filter less than the value. Value must be an integer. * @param {number} [importanceLte] Filter less than or equal to the value. Value must be an integer. - * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system. - * @param {string} [lastUpdatedAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. - * @param {string} [lastUpdatedGt] Filter greater than the value. - * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. - * @param {string} [lastUpdatedLt] Filter less than the value. - * @param {string} [lastUpdatedLte] Filter less than or equal to the value. + * @param {string} [lastUpdated] The timestamp (formatted as an ISO 8601 timestamp) when the rating was last updated in the system. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedGt] Filter greater than the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedGte] Filter greater than or equal to the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedLt] Filter less than the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastUpdatedLte] Filter less than or equal to the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. * @param {string} [ratingAction] The description of the change in rating from the firm\'s last rating. Possible values include: downgrades, maintains, reinstates, reiterates, upgrades, assumes, initiates_coverage_on, terminates_coverage_on, removes, suspends, firm_dissolved. * @param {string} [ratingActionAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [ratingActionGt] Filter greater than the value. @@ -26803,13 +34732,48 @@ export class DefaultApi extends BaseAPI { * @param {string} [benzingaFirmIdLt] Filter less than the value. * @param {string} [benzingaFirmIdLte] Filter less than or equal to the value. * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. - * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'desc\' if not specified. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'last_updated\' if not specified. The sort order defaults to \'desc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public getBenzingaV1Ratings(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, importance?: number, importanceGt?: number, importanceGte?: number, importanceLt?: number, importanceLte?: number, lastUpdated?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, ratingAction?: string, ratingActionAnyOf?: string, ratingActionGt?: string, ratingActionGte?: string, ratingActionLt?: string, ratingActionLte?: string, priceTargetAction?: string, priceTargetActionAnyOf?: string, priceTargetActionGt?: string, priceTargetActionGte?: string, priceTargetActionLt?: string, priceTargetActionLte?: string, benzingaId?: string, benzingaIdAnyOf?: string, benzingaIdGt?: string, benzingaIdGte?: string, benzingaIdLt?: string, benzingaIdLte?: string, benzingaAnalystId?: string, benzingaAnalystIdAnyOf?: string, benzingaAnalystIdGt?: string, benzingaAnalystIdGte?: string, benzingaAnalystIdLt?: string, benzingaAnalystIdLte?: string, benzingaFirmId?: string, benzingaFirmIdAnyOf?: string, benzingaFirmIdGt?: string, benzingaFirmIdGte?: string, benzingaFirmIdLt?: string, benzingaFirmIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).getBenzingaV1Ratings(date, dateAnyOf, dateGt, dateGte, dateLt, dateLte, ticker, tickerAnyOf, tickerGt, tickerGte, tickerLt, tickerLte, importance, importanceGt, importanceGte, importanceLt, importanceLte, lastUpdated, lastUpdatedGt, lastUpdatedGte, lastUpdatedLt, lastUpdatedLte, ratingAction, ratingActionAnyOf, ratingActionGt, ratingActionGte, ratingActionLt, ratingActionLte, priceTargetAction, priceTargetActionAnyOf, priceTargetActionGt, priceTargetActionGte, priceTargetActionLt, priceTargetActionLte, benzingaId, benzingaIdAnyOf, benzingaIdGt, benzingaIdGte, benzingaIdLt, benzingaIdLte, benzingaAnalystId, benzingaAnalystIdAnyOf, benzingaAnalystIdGt, benzingaAnalystIdGte, benzingaAnalystIdLt, benzingaAnalystIdLte, benzingaFirmId, benzingaFirmIdAnyOf, benzingaFirmIdGt, benzingaFirmIdGte, benzingaFirmIdLt, benzingaFirmIdLte, limit, sort, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * A comprehensive news article database from Benzinga, containing detailed information about financial news articles including metadata, content, and associated financial information. + * @param {string} [published] The timestamp (formatted as an ISO 8601 timestamp) when the news article was originally published. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [publishedGt] Filter greater than the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [publishedGte] Filter greater than or equal to the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [publishedLt] Filter less than the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [publishedLte] Filter less than or equal to the value. Value must be an integer timestamp in seconds or formatted \'yyyy-mm-dd\'. + * @param {string} [channels] Filter for arrays that contain the value. + * @param {string} [channelsAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [channelsAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tags] Filter for arrays that contain the value. + * @param {string} [tagsAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tagsAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [author] The name of the journalist or entity that authored the news article. + * @param {string} [authorAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [authorGt] Filter greater than the value. + * @param {string} [authorGte] Filter greater than or equal to the value. + * @param {string} [authorLt] Filter less than the value. + * @param {string} [authorLte] Filter less than or equal to the value. + * @param {string} [stocks] Filter for arrays that contain the value. + * @param {string} [stocksAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [stocksAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickers] Filter for arrays that contain the value. + * @param {string} [tickersAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickersAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'published\' if not specified. The sort order defaults to \'desc\' if not specified. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ - public getBenzingaV1Ratings(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, importance?: number, importanceAnyOf?: string, importanceGt?: number, importanceGte?: number, importanceLt?: number, importanceLte?: number, lastUpdated?: string, lastUpdatedAnyOf?: string, lastUpdatedGt?: string, lastUpdatedGte?: string, lastUpdatedLt?: string, lastUpdatedLte?: string, ratingAction?: string, ratingActionAnyOf?: string, ratingActionGt?: string, ratingActionGte?: string, ratingActionLt?: string, ratingActionLte?: string, priceTargetAction?: string, priceTargetActionAnyOf?: string, priceTargetActionGt?: string, priceTargetActionGte?: string, priceTargetActionLt?: string, priceTargetActionLte?: string, benzingaId?: string, benzingaIdAnyOf?: string, benzingaIdGt?: string, benzingaIdGte?: string, benzingaIdLt?: string, benzingaIdLte?: string, benzingaAnalystId?: string, benzingaAnalystIdAnyOf?: string, benzingaAnalystIdGt?: string, benzingaAnalystIdGte?: string, benzingaAnalystIdLt?: string, benzingaAnalystIdLte?: string, benzingaFirmId?: string, benzingaFirmIdAnyOf?: string, benzingaFirmIdGt?: string, benzingaFirmIdGte?: string, benzingaFirmIdLt?: string, benzingaFirmIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig) { - return DefaultApiFp(this.configuration).getBenzingaV1Ratings(date, dateAnyOf, dateGt, dateGte, dateLt, dateLte, ticker, tickerAnyOf, tickerGt, tickerGte, tickerLt, tickerLte, importance, importanceAnyOf, importanceGt, importanceGte, importanceLt, importanceLte, lastUpdated, lastUpdatedAnyOf, lastUpdatedGt, lastUpdatedGte, lastUpdatedLt, lastUpdatedLte, ratingAction, ratingActionAnyOf, ratingActionGt, ratingActionGte, ratingActionLt, ratingActionLte, priceTargetAction, priceTargetActionAnyOf, priceTargetActionGt, priceTargetActionGte, priceTargetActionLt, priceTargetActionLte, benzingaId, benzingaIdAnyOf, benzingaIdGt, benzingaIdGte, benzingaIdLt, benzingaIdLte, benzingaAnalystId, benzingaAnalystIdAnyOf, benzingaAnalystIdGt, benzingaAnalystIdGte, benzingaAnalystIdLt, benzingaAnalystIdLte, benzingaFirmId, benzingaFirmIdAnyOf, benzingaFirmIdGt, benzingaFirmIdGte, benzingaFirmIdLt, benzingaFirmIdLte, limit, sort, options).then((request) => request(this.axios, this.basePath)); + public getBenzingaV2News(published?: string, publishedGt?: string, publishedGte?: string, publishedLt?: string, publishedLte?: string, channels?: string, channelsAllOf?: string, channelsAnyOf?: string, tags?: string, tagsAllOf?: string, tagsAnyOf?: string, author?: string, authorAnyOf?: string, authorGt?: string, authorGte?: string, authorLt?: string, authorLte?: string, stocks?: string, stocksAllOf?: string, stocksAnyOf?: string, tickers?: string, tickersAllOf?: string, tickersAnyOf?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).getBenzingaV2News(published, publishedGt, publishedGte, publishedLt, publishedLte, channels, channelsAllOf, channelsAnyOf, tags, tagsAllOf, tagsAnyOf, author, authorAnyOf, authorGt, authorGte, authorLt, authorLte, stocks, stocksAllOf, stocksAnyOf, tickers, tickersAllOf, tickersAnyOf, limit, sort, options).then((request) => request(this.axios, this.basePath)); } /** @@ -26822,7 +34786,7 @@ export class DefaultApi extends BaseAPI { * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetCryptoAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). - * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. + * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://massive.com/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi @@ -26996,6 +34960,17 @@ export class DefaultApi extends BaseAPI { return DefaultApiFp(this.configuration).getCryptoTrades(cryptoTicker, timestamp, timestampGte, timestampGt, timestampLte, timestampLt, order, limit, sort, options).then((request) => request(this.axios, this.basePath)); } + /** + * Global cryptocurrency exchanges and digital asset trading platforms, including major centralized exchanges (Coinbase, Binance, Bitfinex, etc.) that facilitate trading of cryptocurrencies and digital tokens worldwide. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'999\'. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public getCryptoV1Exchanges(limit?: number, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).getCryptoV1Exchanges(limit, options).then((request) => request(this.axios, this.basePath)); + } + /** * Get currency conversions using the latest market conversion rates. Note than you can convert in both directions. For example USD to CAD or CAD to USD. * @summary Real-time Currency Conversion @@ -27011,10 +34986,231 @@ export class DefaultApi extends BaseAPI { return DefaultApiFp(this.configuration).getCurrencyConversion(from, to, amount, precision, options).then((request) => request(this.axios, this.basePath)); } + /** + * ETF Global analytics data containing risk scores, reward metrics, and quantitative analysis for ETF composite tickers. + * @param {string} [compositeTicker] The stock ticker symbol used to identify this ETF product on exchanges. + * @param {string} [compositeTickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [compositeTickerGt] Filter greater than the value. + * @param {string} [compositeTickerGte] Filter greater than or equal to the value. + * @param {string} [compositeTickerLt] Filter less than the value. + * @param {string} [compositeTickerLte] Filter less than or equal to the value. + * @param {string} [processedDate] The date showing when ETF Global received and processed the data. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDate] The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {number} [riskTotalScore] ETF Global\'s proprietary Red Diamond overall risk assessment score for the ETF. Value must be a floating point number. + * @param {number} [riskTotalScoreGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [riskTotalScoreGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [riskTotalScoreLt] Filter less than the value. Value must be a floating point number. + * @param {number} [riskTotalScoreLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [rewardScore] ETF Global\'s proprietary Green Diamond score measuring the potential reward and return prospects of the ETF. Value must be a floating point number. + * @param {number} [rewardScoreGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [rewardScoreGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [rewardScoreLt] Filter less than the value. Value must be a floating point number. + * @param {number} [rewardScoreLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quantTotalScore] ETF Global\'s comprehensive quantitative analysis score combining all quantitative factors. Value must be a floating point number. + * @param {number} [quantTotalScoreGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantTotalScoreGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantTotalScoreLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantTotalScoreLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {string} [quantGrade] Letter grade summarizing the ETF\'s overall quantitative assessment, where A = 71-100, B = 56-70, etc. + * @param {string} [quantGradeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [quantGradeGt] Filter greater than the value. + * @param {string} [quantGradeGte] Filter greater than or equal to the value. + * @param {string} [quantGradeLt] Filter less than the value. + * @param {string} [quantGradeLte] Filter less than or equal to the value. + * @param {number} [quantCompositeTechnical] Combined technical analysis score aggregating short, intermediate, and long-term technical factors. Value must be a floating point number. + * @param {number} [quantCompositeTechnicalGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantCompositeTechnicalGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeTechnicalLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantCompositeTechnicalLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeSentiment] Overall market sentiment score combining put/call ratios, short interest, and implied volatility. Value must be a floating point number. + * @param {number} [quantCompositeSentimentGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantCompositeSentimentGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeSentimentLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantCompositeSentimentLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeBehavioral] Behavioral analysis score measuring investor psychology and market behavior patterns. Value must be a floating point number. + * @param {number} [quantCompositeBehavioralGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantCompositeBehavioralGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeBehavioralLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantCompositeBehavioralLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeFundamental] Overall fundamental analysis score combining P/E, P/CF, P/B, and dividend yield metrics. Value must be a floating point number. + * @param {number} [quantCompositeFundamentalGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantCompositeFundamentalGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeFundamentalLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantCompositeFundamentalLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeGlobal] Overall global theme score combining sector and country analysis for macro investment views. Value must be a floating point number. + * @param {number} [quantCompositeGlobalGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantCompositeGlobalGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeGlobalLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantCompositeGlobalLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeQuality] Overall quality assessment score combining liquidity, diversification, and issuing firm factors. Value must be a floating point number. + * @param {number} [quantCompositeQualityGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quantCompositeQualityGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quantCompositeQualityLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quantCompositeQualityLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'5000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'composite_ticker\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public getEtfGlobalV1Analytics(compositeTicker?: string, compositeTickerAnyOf?: string, compositeTickerGt?: string, compositeTickerGte?: string, compositeTickerLt?: string, compositeTickerLte?: string, processedDate?: string, processedDateGt?: string, processedDateGte?: string, processedDateLt?: string, processedDateLte?: string, effectiveDate?: string, effectiveDateGt?: string, effectiveDateGte?: string, effectiveDateLt?: string, effectiveDateLte?: string, riskTotalScore?: number, riskTotalScoreGt?: number, riskTotalScoreGte?: number, riskTotalScoreLt?: number, riskTotalScoreLte?: number, rewardScore?: number, rewardScoreGt?: number, rewardScoreGte?: number, rewardScoreLt?: number, rewardScoreLte?: number, quantTotalScore?: number, quantTotalScoreGt?: number, quantTotalScoreGte?: number, quantTotalScoreLt?: number, quantTotalScoreLte?: number, quantGrade?: string, quantGradeAnyOf?: string, quantGradeGt?: string, quantGradeGte?: string, quantGradeLt?: string, quantGradeLte?: string, quantCompositeTechnical?: number, quantCompositeTechnicalGt?: number, quantCompositeTechnicalGte?: number, quantCompositeTechnicalLt?: number, quantCompositeTechnicalLte?: number, quantCompositeSentiment?: number, quantCompositeSentimentGt?: number, quantCompositeSentimentGte?: number, quantCompositeSentimentLt?: number, quantCompositeSentimentLte?: number, quantCompositeBehavioral?: number, quantCompositeBehavioralGt?: number, quantCompositeBehavioralGte?: number, quantCompositeBehavioralLt?: number, quantCompositeBehavioralLte?: number, quantCompositeFundamental?: number, quantCompositeFundamentalGt?: number, quantCompositeFundamentalGte?: number, quantCompositeFundamentalLt?: number, quantCompositeFundamentalLte?: number, quantCompositeGlobal?: number, quantCompositeGlobalGt?: number, quantCompositeGlobalGte?: number, quantCompositeGlobalLt?: number, quantCompositeGlobalLte?: number, quantCompositeQuality?: number, quantCompositeQualityGt?: number, quantCompositeQualityGte?: number, quantCompositeQualityLt?: number, quantCompositeQualityLte?: number, limit?: number, sort?: string, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).getEtfGlobalV1Analytics(compositeTicker, compositeTickerAnyOf, compositeTickerGt, compositeTickerGte, compositeTickerLt, compositeTickerLte, processedDate, processedDateGt, processedDateGte, processedDateLt, processedDateLte, effectiveDate, effectiveDateGt, effectiveDateGte, effectiveDateLt, effectiveDateLte, riskTotalScore, riskTotalScoreGt, riskTotalScoreGte, riskTotalScoreLt, riskTotalScoreLte, rewardScore, rewardScoreGt, rewardScoreGte, rewardScoreLt, rewardScoreLte, quantTotalScore, quantTotalScoreGt, quantTotalScoreGte, quantTotalScoreLt, quantTotalScoreLte, quantGrade, quantGradeAnyOf, quantGradeGt, quantGradeGte, quantGradeLt, quantGradeLte, quantCompositeTechnical, quantCompositeTechnicalGt, quantCompositeTechnicalGte, quantCompositeTechnicalLt, quantCompositeTechnicalLte, quantCompositeSentiment, quantCompositeSentimentGt, quantCompositeSentimentGte, quantCompositeSentimentLt, quantCompositeSentimentLte, quantCompositeBehavioral, quantCompositeBehavioralGt, quantCompositeBehavioralGte, quantCompositeBehavioralLt, quantCompositeBehavioralLte, quantCompositeFundamental, quantCompositeFundamentalGt, quantCompositeFundamentalGte, quantCompositeFundamentalLt, quantCompositeFundamentalLte, quantCompositeGlobal, quantCompositeGlobalGt, quantCompositeGlobalGte, quantCompositeGlobalLt, quantCompositeGlobalLte, quantCompositeQuality, quantCompositeQualityGt, quantCompositeQualityGte, quantCompositeQualityLt, quantCompositeQualityLte, limit, sort, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * ETF Global constituents data containing detailed information about the securities held within ETFs, including weights, market values, and security identifiers. + * @param {string} [compositeTicker] The stock ticker symbol of the ETF that holds these constituent securities. + * @param {string} [compositeTickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [compositeTickerGt] Filter greater than the value. + * @param {string} [compositeTickerGte] Filter greater than or equal to the value. + * @param {string} [compositeTickerLt] Filter less than the value. + * @param {string} [compositeTickerLte] Filter less than or equal to the value. + * @param {string} [constituentTicker] The stock ticker symbol of the individual security held within the ETF. + * @param {string} [constituentTickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [constituentTickerGt] Filter greater than the value. + * @param {string} [constituentTickerGte] Filter greater than or equal to the value. + * @param {string} [constituentTickerLt] Filter less than the value. + * @param {string} [constituentTickerLte] Filter less than or equal to the value. + * @param {string} [effectiveDate] The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDate] The date showing when ETF Global received and processed the data. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [usCode] A unique identifier code for the constituent security in US markets. + * @param {string} [usCodeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [usCodeGt] Filter greater than the value. + * @param {string} [usCodeGte] Filter greater than or equal to the value. + * @param {string} [usCodeLt] Filter less than the value. + * @param {string} [usCodeLte] Filter less than or equal to the value. + * @param {string} [isin] The International Securities Identification Number, a global standard for identifying securities. + * @param {string} [isinAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [isinGt] Filter greater than the value. + * @param {string} [isinGte] Filter greater than or equal to the value. + * @param {string} [isinLt] Filter less than the value. + * @param {string} [isinLte] Filter less than or equal to the value. + * @param {string} [figi] The Financial Instrument Global Identifier, an open standard for uniquely identifying financial instruments. + * @param {string} [figiAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [figiGt] Filter greater than the value. + * @param {string} [figiGte] Filter greater than or equal to the value. + * @param {string} [figiLt] Filter less than the value. + * @param {string} [figiLte] Filter less than or equal to the value. + * @param {string} [sedol] The Stock Exchange Daily Official List code, primarily used for securities trading in the UK. + * @param {string} [sedolAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [sedolGt] Filter greater than the value. + * @param {string} [sedolGte] Filter greater than or equal to the value. + * @param {string} [sedolLt] Filter less than the value. + * @param {string} [sedolLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'5000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'composite_ticker\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public getEtfGlobalV1Constituents(compositeTicker?: string, compositeTickerAnyOf?: string, compositeTickerGt?: string, compositeTickerGte?: string, compositeTickerLt?: string, compositeTickerLte?: string, constituentTicker?: string, constituentTickerAnyOf?: string, constituentTickerGt?: string, constituentTickerGte?: string, constituentTickerLt?: string, constituentTickerLte?: string, effectiveDate?: string, effectiveDateGt?: string, effectiveDateGte?: string, effectiveDateLt?: string, effectiveDateLte?: string, processedDate?: string, processedDateGt?: string, processedDateGte?: string, processedDateLt?: string, processedDateLte?: string, usCode?: string, usCodeAnyOf?: string, usCodeGt?: string, usCodeGte?: string, usCodeLt?: string, usCodeLte?: string, isin?: string, isinAnyOf?: string, isinGt?: string, isinGte?: string, isinLt?: string, isinLte?: string, figi?: string, figiAnyOf?: string, figiGt?: string, figiGte?: string, figiLt?: string, figiLte?: string, sedol?: string, sedolAnyOf?: string, sedolGt?: string, sedolGte?: string, sedolLt?: string, sedolLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).getEtfGlobalV1Constituents(compositeTicker, compositeTickerAnyOf, compositeTickerGt, compositeTickerGte, compositeTickerLt, compositeTickerLte, constituentTicker, constituentTickerAnyOf, constituentTickerGt, constituentTickerGte, constituentTickerLt, constituentTickerLte, effectiveDate, effectiveDateGt, effectiveDateGte, effectiveDateLt, effectiveDateLte, processedDate, processedDateGt, processedDateGte, processedDateLt, processedDateLte, usCode, usCodeAnyOf, usCodeGt, usCodeGte, usCodeLt, usCodeLte, isin, isinAnyOf, isinGt, isinGte, isinLt, isinLte, figi, figiAnyOf, figiGt, figiGte, figiLt, figiLte, sedol, sedolAnyOf, sedolGt, sedolGte, sedolLt, sedolLte, limit, sort, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * ETF Global fund flow data containing information about ETF share movements, net asset values, and fund flow metrics. + * @param {string} [processedDate] The date showing when ETF Global received and processed the data. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDate] The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [compositeTicker] The stock ticker symbol used to identify this ETF on exchanges. + * @param {string} [compositeTickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [compositeTickerGt] Filter greater than the value. + * @param {string} [compositeTickerGte] Filter greater than or equal to the value. + * @param {string} [compositeTickerLt] Filter less than the value. + * @param {string} [compositeTickerLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'5000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'composite_ticker\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public getEtfGlobalV1FundFlows(processedDate?: string, processedDateGt?: string, processedDateGte?: string, processedDateLt?: string, processedDateLte?: string, effectiveDate?: string, effectiveDateGt?: string, effectiveDateGte?: string, effectiveDateLt?: string, effectiveDateLte?: string, compositeTicker?: string, compositeTickerAnyOf?: string, compositeTickerGt?: string, compositeTickerGte?: string, compositeTickerLt?: string, compositeTickerLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).getEtfGlobalV1FundFlows(processedDate, processedDateGt, processedDateGte, processedDateLt, processedDateLte, effectiveDate, effectiveDateGt, effectiveDateGte, effectiveDateLt, effectiveDateLte, compositeTicker, compositeTickerAnyOf, compositeTickerGt, compositeTickerGte, compositeTickerLt, compositeTickerLte, limit, sort, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * ETF Global industry profile data containing comprehensive ETF metadata including financial metrics, operational details, and exposure information. + * @param {string} [processedDate] The date showing when ETF Global received and processed the data. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDate] The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [compositeTicker] The stock ticker symbol used to identify this ETF product on exchanges. + * @param {string} [compositeTickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [compositeTickerGt] Filter greater than the value. + * @param {string} [compositeTickerGte] Filter greater than or equal to the value. + * @param {string} [compositeTickerLt] Filter less than the value. + * @param {string} [compositeTickerLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'5000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'composite_ticker\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public getEtfGlobalV1Profiles(processedDate?: string, processedDateGt?: string, processedDateGte?: string, processedDateLt?: string, processedDateLte?: string, effectiveDate?: string, effectiveDateGt?: string, effectiveDateGte?: string, effectiveDateLt?: string, effectiveDateLte?: string, compositeTicker?: string, compositeTickerAnyOf?: string, compositeTickerGt?: string, compositeTickerGte?: string, compositeTickerLt?: string, compositeTickerLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).getEtfGlobalV1Profiles(processedDate, processedDateGt, processedDateGte, processedDateLt, processedDateLte, effectiveDate, effectiveDateGt, effectiveDateGte, effectiveDateLt, effectiveDateLte, compositeTicker, compositeTickerAnyOf, compositeTickerGt, compositeTickerGte, compositeTickerLt, compositeTickerLte, limit, sort, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * ETF Global taxonomy data containing detailed classification and categorization information for ETFs including investment strategy, methodology, and structural characteristics. + * @param {string} [processedDate] The date showing when ETF Global received and processed the data. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [processedDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDate] The date showing when the information was accurate or valid; some issuers, such as Vanguard, release their data on a delay, so the effective_date can be several weeks earlier than the processed_date. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [effectiveDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [compositeTicker] The stock ticker symbol used to identify this ETF product on exchanges. + * @param {string} [compositeTickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [compositeTickerGt] Filter greater than the value. + * @param {string} [compositeTickerGte] Filter greater than or equal to the value. + * @param {string} [compositeTickerLt] Filter less than the value. + * @param {string} [compositeTickerLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'5000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'composite_ticker\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public getEtfGlobalV1Taxonomies(processedDate?: string, processedDateGt?: string, processedDateGte?: string, processedDateLt?: string, processedDateLte?: string, effectiveDate?: string, effectiveDateGt?: string, effectiveDateGte?: string, effectiveDateLt?: string, effectiveDateLte?: string, compositeTicker?: string, compositeTickerAnyOf?: string, compositeTickerGt?: string, compositeTickerGte?: string, compositeTickerLt?: string, compositeTickerLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).getEtfGlobalV1Taxonomies(processedDate, processedDateGt, processedDateGte, processedDateLt, processedDateLte, effectiveDate, effectiveDateGt, effectiveDateGte, effectiveDateLt, effectiveDateLte, compositeTicker, compositeTickerAnyOf, compositeTickerGt, compositeTickerGte, compositeTickerLt, compositeTickerLte, limit, sort, options).then((request) => request(this.axios, this.basePath)); + } + /** * Get a timeline of events for the entity associated with the given ticker, CUSIP, or Composite FIGI. * @summary Ticker Events - * @param {string} id Identifier of an asset, which can be a Ticker, CUSIP, or Composite FIGI. Specify a case-sensitive ticker symbol (e.g. AAPL for Apple Inc). When provided a ticker, events for the entity currently represented by that ticker are returned. To find events for entities previously associated with a ticker, obtain the relevant identifier using the [Ticker Details Endpoint](https://polygon.io/docs/stocks/get_v3_reference_tickers__ticker). + * @param {string} id Identifier of an asset, which can be a Ticker, CUSIP, or Composite FIGI. Specify a case-sensitive ticker symbol (e.g. AAPL for Apple Inc). When provided a ticker, events for the entity currently represented by that ticker are returned. To find events for entities previously associated with a ticker, obtain the relevant identifier using the [Ticker Details Endpoint](https://massive.com/docs/stocks/get_v3_reference_tickers__ticker). * @param {string} [types] A comma-separated list of the types of event to include. Currently ticker_change is the only supported event_type. Leave blank to return all supported event_types. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -27088,7 +35284,7 @@ export class DefaultApi extends BaseAPI { * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetForexAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). - * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. + * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://massive.com/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi @@ -27251,12 +35447,23 @@ export class DefaultApi extends BaseAPI { return DefaultApiFp(this.configuration).getForexSnapshotTickers(tickers, options).then((request) => request(this.axios, this.basePath)); } + /** + * Global foreign exchange (FX) trading venues and market infrastructure, including electronic trading platforms, banks, and other institutions facilitating currency pair trading worldwide. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'999\'. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public getForexV1Exchanges(limit?: number, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).getForexV1Exchanges(limit, options).then((request) => request(this.axios, this.basePath)); + } + /** * Get aggregates for a contract in a given time range. * @summary Aggregates * @param {string} ticker The futures contract identifier, including the base symbol and contract expiration (e.g., GCJ5 for the April 2025 gold contract). * @param {string} [resolution] This sets the size of the aggregate windows. It accepts custom values that specify the granularity and the duration of the window. For example: 15mins, 30secs, 12hours, or 7days. There are maximum allowable candle sizes. For example, you can request \"1min\" to \"59mins\", but after that you will need to use \"1hr\". If you make a request for a candle size that is not supported, we will return a 400 \"Bad Request - resolution value is not allowed.\" - * @param {string} [windowStart] This sets the range of time for your results. The window_start timestamp you choose specifies the starting edge of the candle or candles you want returned. If no value is set, you will get the oldest or newest available candles, depending on your sort order. You can combine window_start to form a time range, for example: window_start.gte=2024-01-01&window_start.lte=2024-01-31 + * @param {string} [windowStart] Specifies the start time of the aggregate (OHLC) candles you want returned (YYYY-MM-DD date or nanosecond Unix timestamp). How it works - If not provided, the API returns the most recent candles available, up to the limit you set. - If provided, the value determines which candle(s) to return. The timestamp or date is “snapped” to the start time of the matching candle interval. - You can use comparison operators to form ranges: - `window_start.gte` – greater than or equal to - `window_start.gt` – greater than - `window_start.lte` – less than or equal to - `window_start.lt` – less than Examples 1. Most recent minute candles `/vX/aggs/ESU5?resolution=1min&limit=5` 2. Daily candle for August 5, 2025 `/vX/aggs/ESU5?resolution=1day&window_start=2025-08-05` 3. Daily candles from July 1–31, 2025 `/vX/aggs/ESU5?resolution=1day&window_start.gte=2025-07-01&window_start.lte=2025-07-31` 4. 1,000 one-second candles after a specific timestamp `/vX/aggs/ESU5?resolution=1sec&window_start.gt=1751409877000000000&limit=1000` * @param {number} [limit] The number of results to return per page (default=1000, maximum=50000, minimum=1). * @param {string} [windowStartGte] Range by window_start. * @param {string} [windowStartGt] Range by window_start. @@ -27436,6 +35643,149 @@ export class DefaultApi extends BaseAPI { return DefaultApiFp(this.configuration).getFuturesTrades(ticker, timestamp, sessionEndDate, limit, timestampGte, timestampGt, timestampLte, timestampLt, sessionEndDateGte, sessionEndDateGt, sessionEndDateLte, sessionEndDateLt, sort, options).then((request) => request(this.axios, this.basePath)); } + /** + * Retrieve detailed information about a specific futures contract identified by its ticker. The response includes comprehensive attributes such as active status, trade dates, days to maturity, exchange code, order quantity limits, settlement date, tick sizes, and other key metrics. Users can specify a point-in-time (as_of) to view the contract\'s state on a particular date, supporting informed trading decisions and historical analysis. Use Cases: Contract specification, historical product checks, system integration, trading decision support. + * @summary futures_contracts_v1 API + * @param {string} [date] A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about products for the specified day (default=today). Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [productCode] The unique identifier for the product. + * @param {string} [productCodeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [productCodeGt] Filter greater than the value. + * @param {string} [productCodeGte] Filter greater than or equal to the value. + * @param {string} [productCodeLt] Filter less than the value. + * @param {string} [productCodeLte] Filter less than or equal to the value. + * @param {string} [ticker] The ticker for the contract. + * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickerGt] Filter greater than the value. + * @param {string} [tickerGte] Filter greater than or equal to the value. + * @param {string} [tickerLt] Filter less than the value. + * @param {string} [tickerLte] Filter less than or equal to the value. + * @param {string} [active] The contract is still trading. Value must be \'true\', \'false\', \'1\' or \'0\'. + * @param {string} [type] The type of product, one of \'single\' or \'combo\'. + * @param {string} [typeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [typeGt] Filter greater than the value. + * @param {string} [typeGte] Filter greater than or equal to the value. + * @param {string} [typeLt] Filter less than the value. + * @param {string} [typeLte] Filter less than or equal to the value. + * @param {string} [firstTradeDate] The first date the contract trades. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [firstTradeDateGt] Filter greater than the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [firstTradeDateGte] Filter greater than or equal to the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [firstTradeDateLt] Filter less than the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [firstTradeDateLte] Filter less than or equal to the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastTradeDate] The last date the contract trades. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastTradeDateGt] Filter greater than the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastTradeDateGte] Filter greater than or equal to the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastTradeDateLt] Filter less than the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {string} [lastTradeDateLte] Filter less than or equal to the value. Value must be an integer timestamp in nanoseconds or formatted \'yyyy-mm-dd\'. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'1000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'product_code\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public getFuturesVXContractsNew(date?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, productCode?: string, productCodeAnyOf?: string, productCodeGt?: string, productCodeGte?: string, productCodeLt?: string, productCodeLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, active?: string, type?: string, typeAnyOf?: string, typeGt?: string, typeGte?: string, typeLt?: string, typeLte?: string, firstTradeDate?: string, firstTradeDateGt?: string, firstTradeDateGte?: string, firstTradeDateLt?: string, firstTradeDateLte?: string, lastTradeDate?: string, lastTradeDateGt?: string, lastTradeDateGte?: string, lastTradeDateLt?: string, lastTradeDateLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).getFuturesVXContractsNew(date, dateGt, dateGte, dateLt, dateLte, productCode, productCodeAnyOf, productCodeGt, productCodeGte, productCodeLt, productCodeLte, ticker, tickerAnyOf, tickerGt, tickerGte, tickerLt, tickerLte, active, type, typeAnyOf, typeGt, typeGte, typeLt, typeLte, firstTradeDate, firstTradeDateGt, firstTradeDateGte, firstTradeDateLt, firstTradeDateLte, lastTradeDate, lastTradeDateGt, lastTradeDateGte, lastTradeDateLt, lastTradeDateLte, limit, sort, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * US futures exchanges and trading venues including major derivatives exchanges (CME, CBOT, NYMEX, COMEX) and other futures market infrastructure for commodity, financial, and other derivative contract trading. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'999\'. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public getFuturesVXExchanges(limit?: number, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).getFuturesVXExchanges(limit, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Retrieve detailed information about a single futures product as of a specified date, including its asset class, exchange code, full product name, settlement details, pricing quotation, sector classifications, and unit of measure. Optional parameters such as product type (single or combo) and as_of allow you to capture the product’s state on a specific day, providing essential context for trading decisions and system integrations. Use Cases: Product specification, historical product checks, risk management, trading system integration. + * @summary futures_products_v1 API + * @param {string} [name] The full name of the product. + * @param {string} [nameAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [nameGt] Filter greater than the value. + * @param {string} [nameGte] Filter greater than or equal to the value. + * @param {string} [nameLt] Filter less than the value. + * @param {string} [nameLte] Filter less than or equal to the value. + * @param {string} [productCode] The unique identifier for the product. + * @param {string} [productCodeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [productCodeGt] Filter greater than the value. + * @param {string} [productCodeGte] Filter greater than or equal to the value. + * @param {string} [productCodeLt] Filter less than the value. + * @param {string} [productCodeLte] Filter less than or equal to the value. + * @param {string} [date] A date string in the format YYYY-MM-DD. This parameter will return point-in-time information about products for the specified day (default=today). Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [dateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [sector] The sector to which the product belongs. + * @param {string} [sectorAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [sectorGt] Filter greater than the value. + * @param {string} [sectorGte] Filter greater than or equal to the value. + * @param {string} [sectorLt] Filter less than the value. + * @param {string} [sectorLte] Filter less than or equal to the value. + * @param {string} [subSector] The sub-sector to which the product belongs. + * @param {string} [subSectorAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [subSectorGt] Filter greater than the value. + * @param {string} [subSectorGte] Filter greater than or equal to the value. + * @param {string} [subSectorLt] Filter less than the value. + * @param {string} [subSectorLte] Filter less than or equal to the value. + * @param {string} [assetClass] The asset class to which the product belongs. + * @param {string} [assetClassAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [assetClassGt] Filter greater than the value. + * @param {string} [assetClassGte] Filter greater than or equal to the value. + * @param {string} [assetClassLt] Filter less than the value. + * @param {string} [assetClassLte] Filter less than or equal to the value. + * @param {string} [assetSubClass] The asset sub-class to which the product belongs. + * @param {string} [assetSubClassAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [assetSubClassGt] Filter greater than the value. + * @param {string} [assetSubClassGte] Filter greater than or equal to the value. + * @param {string} [assetSubClassLt] Filter less than the value. + * @param {string} [assetSubClassLte] Filter less than or equal to the value. + * @param {string} [type] The type of product, one of \'single\' or \'combo\'. + * @param {string} [typeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [typeGt] Filter greater than the value. + * @param {string} [typeGte] Filter greater than or equal to the value. + * @param {string} [typeLt] Filter less than the value. + * @param {string} [typeLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'date\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public getFuturesVXProductsNew(name?: string, nameAnyOf?: string, nameGt?: string, nameGte?: string, nameLt?: string, nameLte?: string, productCode?: string, productCodeAnyOf?: string, productCodeGt?: string, productCodeGte?: string, productCodeLt?: string, productCodeLte?: string, date?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, sector?: string, sectorAnyOf?: string, sectorGt?: string, sectorGte?: string, sectorLt?: string, sectorLte?: string, subSector?: string, subSectorAnyOf?: string, subSectorGt?: string, subSectorGte?: string, subSectorLt?: string, subSectorLte?: string, assetClass?: string, assetClassAnyOf?: string, assetClassGt?: string, assetClassGte?: string, assetClassLt?: string, assetClassLte?: string, assetSubClass?: string, assetSubClassAnyOf?: string, assetSubClassGt?: string, assetSubClassGte?: string, assetSubClassLt?: string, assetSubClassLte?: string, type?: string, typeAnyOf?: string, typeGt?: string, typeGte?: string, typeLt?: string, typeLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).getFuturesVXProductsNew(name, nameAnyOf, nameGt, nameGte, nameLt, nameLte, productCode, productCodeAnyOf, productCodeGt, productCodeGte, productCodeLt, productCodeLte, date, dateGt, dateGte, dateLt, dateLte, sector, sectorAnyOf, sectorGt, sectorGte, sectorLt, sectorLte, subSector, subSectorAnyOf, subSectorGt, subSectorGte, subSectorLt, subSectorLte, assetClass, assetClassAnyOf, assetClassGt, assetClassGte, assetClassLt, assetClassLte, assetSubClass, assetSubClassAnyOf, assetSubClassGt, assetSubClassGte, assetSubClassLt, assetSubClassLte, type, typeAnyOf, typeGt, typeGte, typeLt, typeLte, limit, sort, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Retrieve a snapshot of the most recent futures contract data. + * @summary futures_snapshot_v1 API + * @param {string} [productCode] The code for the contracts\' underlying product. + * @param {string} [productCodeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [productCodeGt] Filter greater than the value. + * @param {string} [productCodeGte] Filter greater than or equal to the value. + * @param {string} [productCodeLt] Filter less than the value. + * @param {string} [productCodeLte] Filter less than or equal to the value. + * @param {string} [ticker] The futures contract identifier, including the base symbol and contract expiration (e.g., ESZ24 for the December 2024 S&P 500 E-mini contract). + * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickerGt] Filter greater than the value. + * @param {string} [tickerGte] Filter greater than or equal to the value. + * @param {string} [tickerLt] Filter less than the value. + * @param {string} [tickerLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'ticker\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public getFuturesVXSnapshot(productCode?: string, productCodeAnyOf?: string, productCodeGt?: string, productCodeGte?: string, productCodeLt?: string, productCodeLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).getFuturesVXSnapshot(productCode, productCodeAnyOf, productCodeGt, productCodeGte, productCodeLt, productCodeLte, ticker, tickerAnyOf, tickerGt, tickerGte, tickerLt, tickerLte, limit, sort, options).then((request) => request(this.axios, this.basePath)); + } + /** * Get the daily open, high, low, and close (OHLC) for the entire cryptocurrency markets. * @summary Grouped Daily (Bars) @@ -27485,7 +35835,7 @@ export class DefaultApi extends BaseAPI { * @param {string} from The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {GetIndicesAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). - * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. + * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://massive.com/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi @@ -27732,7 +36082,7 @@ export class DefaultApi extends BaseAPI { * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetOptionsAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). - * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. + * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://massive.com/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi @@ -27770,7 +36120,7 @@ export class DefaultApi extends BaseAPI { /** * Get an options contract * @summary Options Contract - * @param {string} optionsTicker Query for a contract by options ticker. You can learn more about the structure of options tickers [here](https://polygon.io/blog/how-to-read-a-stock-options-ticker/). + * @param {string} optionsTicker Query for a contract by options ticker. You can learn more about the structure of options tickers [here](https://massive.com/blog/how-to-read-a-stock-options-ticker/). * @param {string} [asOf] Specify a point in time for the contract as of this date with format YYYY-MM-DD. Defaults to today\'s date. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -27932,6 +36282,17 @@ export class DefaultApi extends BaseAPI { return DefaultApiFp(this.configuration).getOptionsTrades(optionsTicker, timestamp, timestampGte, timestampGt, timestampLte, timestampLt, order, limit, sort, options).then((request) => request(this.axios, this.basePath)); } + /** + * US options exchanges and trading venues including traditional options exchanges (CBOE, ISE, etc.), Securities Information Processors (SIP), and other options market infrastructure for derivatives trading. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'999\'. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public getOptionsV1Exchanges(limit?: number, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).getOptionsV1Exchanges(limit, options).then((request) => request(this.axios, this.basePath)); + } + /** * Get the previous day\'s open, high, low, and close (OHLC) for the specified cryptocurrency pair. * @summary Previous Close @@ -28011,7 +36372,7 @@ export class DefaultApi extends BaseAPI { /** * Get everything needed to visualize the tick-by-tick movement of a list of tickers. * @summary Summaries - * @param {string} [tickerAnyOf] Comma separated list of tickers. This API currently supports Stocks/Equities, Crypto, Options, and Forex. See <a rel=\"nofollow\" target=\"_blank\" href=\"https://polygon.io/docs/stocks/get_v3_reference_tickers\">the tickers endpoint</a> for more details on supported tickers. If no tickers are passed then no results will be returned. Warning: The maximum number of characters allowed in a URL are subject to your technology stack. + * @param {string} [tickerAnyOf] Comma separated list of tickers. This API currently supports Stocks/Equities, Crypto, Options, and Forex. See <a rel=\"nofollow\" target=\"_blank\" href=\"https://massive.com/docs/stocks/get_v3_reference_tickers\">the tickers endpoint</a> for more details on supported tickers. If no tickers are passed then no results will be returned. Warning: The maximum number of characters allowed in a URL are subject to your technology stack. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi @@ -28051,7 +36412,7 @@ export class DefaultApi extends BaseAPI { * @param {string} to The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. * @param {boolean} [adjusted] Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits. * @param {GetStocksAggregatesSortEnum} [sort] Sort the results by timestamp. `asc` will return results in ascending order (oldest at the top), `desc` will return results in descending order (newest at the top). - * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://polygon.io/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. + * @param {number} [limit] Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href=\"https://massive.com/blog/aggs-api-updates/\" target=\"_blank\" alt=\"Aggregate Data API Improvements\">Aggregate Data API Improvements</a>. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi @@ -28084,6 +36445,271 @@ export class DefaultApi extends BaseAPI { return DefaultApiFp(this.configuration).getStocksEMA(stockTicker, timestamp, timespan, adjusted, window, seriesType, expandUnderlying, order, limit, timestampGte, timestampGt, timestampLte, timestampLt, options).then((request) => request(this.axios, this.basePath)); } + /** + * A comprehensive financial dataset containing quarterly and annual balance sheet data for public companies. Includes detailed asset, liability, and equity positions representing the company\'s financial position at specific points in time. Balance sheet data represents point-in-time snapshots rather than cumulative flows, showing what the company owns, owes, and shareholders\' equity as of each period end date. + * @param {string} [cik] The company\'s Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company\'s CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup). + * @param {string} [cikAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [cikGt] Filter greater than the value. + * @param {string} [cikGte] Filter greater than or equal to the value. + * @param {string} [cikLt] Filter less than the value. + * @param {string} [cikLte] Filter less than or equal to the value. + * @param {string} [tickers] Filter for arrays that contain the value. + * @param {string} [tickersAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickersAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [periodEnd] The last date of the reporting period, representing the specific point in time when the balance sheet snapshot was taken. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDate] The date when the financial statement was filed with the SEC. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {number} [fiscalYear] The fiscal year for the reporting period. Value must be a floating point number. + * @param {number} [fiscalYearGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [fiscalYearGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalYearLt] Filter less than the value. Value must be a floating point number. + * @param {number} [fiscalYearLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalQuarter] The fiscal quarter number (1, 2, 3, or 4) for the reporting period. Value must be a floating point number. + * @param {number} [fiscalQuarterGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [fiscalQuarterGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalQuarterLt] Filter less than the value. Value must be a floating point number. + * @param {number} [fiscalQuarterLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {string} [timeframe] The reporting period type. Possible values include: quarterly, annual. + * @param {string} [timeframeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [timeframeGt] Filter greater than the value. + * @param {string} [timeframeGte] Filter greater than or equal to the value. + * @param {string} [timeframeLt] Filter less than the value. + * @param {string} [timeframeLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'period_end\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public getStocksFinancialsV1BalanceSheets(cik?: string, cikAnyOf?: string, cikGt?: string, cikGte?: string, cikLt?: string, cikLte?: string, tickers?: string, tickersAllOf?: string, tickersAnyOf?: string, periodEnd?: string, periodEndGt?: string, periodEndGte?: string, periodEndLt?: string, periodEndLte?: string, filingDate?: string, filingDateGt?: string, filingDateGte?: string, filingDateLt?: string, filingDateLte?: string, fiscalYear?: number, fiscalYearGt?: number, fiscalYearGte?: number, fiscalYearLt?: number, fiscalYearLte?: number, fiscalQuarter?: number, fiscalQuarterGt?: number, fiscalQuarterGte?: number, fiscalQuarterLt?: number, fiscalQuarterLte?: number, timeframe?: string, timeframeAnyOf?: string, timeframeGt?: string, timeframeGte?: string, timeframeLt?: string, timeframeLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).getStocksFinancialsV1BalanceSheets(cik, cikAnyOf, cikGt, cikGte, cikLt, cikLte, tickers, tickersAllOf, tickersAnyOf, periodEnd, periodEndGt, periodEndGte, periodEndLt, periodEndLte, filingDate, filingDateGt, filingDateGte, filingDateLt, filingDateLte, fiscalYear, fiscalYearGt, fiscalYearGte, fiscalYearLt, fiscalYearLte, fiscalQuarter, fiscalQuarterGt, fiscalQuarterGte, fiscalQuarterLt, fiscalQuarterLte, timeframe, timeframeAnyOf, timeframeGt, timeframeGte, timeframeLt, timeframeLte, limit, sort, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * A comprehensive financial dataset containing quarterly, annual, and trailing twelve-month cash flow statement data for public companies. Includes detailed operating, investing, and financing cash flows with proper TTM calculations that sum all cash flow components over four quarters. TTM records are validated to ensure exactly four distinct quarters spanning 250-400 days for accurate trailing twelve-month cash flow analysis. + * @param {string} [cik] The company\'s Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company’s CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup). + * @param {string} [cikAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [cikGt] Filter greater than the value. + * @param {string} [cikGte] Filter greater than or equal to the value. + * @param {string} [cikLt] Filter less than the value. + * @param {string} [cikLte] Filter less than or equal to the value. + * @param {string} [periodEnd] The last date of the reporting period (formatted as YYYY-MM-DD). Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDate] The date when the financial statement was filed with the SEC. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [tickers] Filter for arrays that contain the value. + * @param {string} [tickersAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickersAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {number} [fiscalYear] The fiscal year for the reporting period. Value must be a floating point number. + * @param {number} [fiscalYearGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [fiscalYearGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalYearLt] Filter less than the value. Value must be a floating point number. + * @param {number} [fiscalYearLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalQuarter] The fiscal quarter number (1, 2, 3, or 4) for the reporting period. Value must be a floating point number. + * @param {number} [fiscalQuarterGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [fiscalQuarterGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalQuarterLt] Filter less than the value. Value must be a floating point number. + * @param {number} [fiscalQuarterLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {string} [timeframe] The reporting period type. Possible values include: quarterly, annual, trailing_twelve_months. + * @param {string} [timeframeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [timeframeGt] Filter greater than the value. + * @param {string} [timeframeGte] Filter greater than or equal to the value. + * @param {string} [timeframeLt] Filter less than the value. + * @param {string} [timeframeLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'period_end\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public getStocksFinancialsV1CashFlowStatements(cik?: string, cikAnyOf?: string, cikGt?: string, cikGte?: string, cikLt?: string, cikLte?: string, periodEnd?: string, periodEndGt?: string, periodEndGte?: string, periodEndLt?: string, periodEndLte?: string, filingDate?: string, filingDateGt?: string, filingDateGte?: string, filingDateLt?: string, filingDateLte?: string, tickers?: string, tickersAllOf?: string, tickersAnyOf?: string, fiscalYear?: number, fiscalYearGt?: number, fiscalYearGte?: number, fiscalYearLt?: number, fiscalYearLte?: number, fiscalQuarter?: number, fiscalQuarterGt?: number, fiscalQuarterGte?: number, fiscalQuarterLt?: number, fiscalQuarterLte?: number, timeframe?: string, timeframeAnyOf?: string, timeframeGt?: string, timeframeGte?: string, timeframeLt?: string, timeframeLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).getStocksFinancialsV1CashFlowStatements(cik, cikAnyOf, cikGt, cikGte, cikLt, cikLte, periodEnd, periodEndGt, periodEndGte, periodEndLt, periodEndLte, filingDate, filingDateGt, filingDateGte, filingDateLt, filingDateLte, tickers, tickersAllOf, tickersAnyOf, fiscalYear, fiscalYearGt, fiscalYearGte, fiscalYearLt, fiscalYearLte, fiscalQuarter, fiscalQuarterGt, fiscalQuarterGte, fiscalQuarterLt, fiscalQuarterLte, timeframe, timeframeAnyOf, timeframeGt, timeframeGte, timeframeLt, timeframeLte, limit, sort, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * A comprehensive database of income statement financial data for public companies, including key metrics such as revenue, expenses, and net income for various reporting periods. + * @param {string} [cik] The company\'s Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company’s CIK using the [SEC CIK Lookup tool](https://www.sec.gov/search-filings/cik-lookup). + * @param {string} [cikAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [cikGt] Filter greater than the value. + * @param {string} [cikGte] Filter greater than or equal to the value. + * @param {string} [cikLt] Filter less than the value. + * @param {string} [cikLte] Filter less than or equal to the value. + * @param {string} [tickers] Filter for arrays that contain the value. + * @param {string} [tickersAllOf] Filter for arrays that contain all of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickersAnyOf] Filter for arrays that contain any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [periodEnd] The last date of the reporting period (formatted as YYYY-MM-DD). Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [periodEndLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDate] The date when the financial statement was filed with the SEC. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateGt] Filter greater than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateGte] Filter greater than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateLt] Filter less than the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {string} [filingDateLte] Filter less than or equal to the value. Value must be formatted \'yyyy-mm-dd\'. + * @param {number} [fiscalYear] The fiscal year for the reporting period. Value must be a floating point number. + * @param {number} [fiscalYearGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [fiscalYearGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalYearLt] Filter less than the value. Value must be a floating point number. + * @param {number} [fiscalYearLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalQuarter] The fiscal quarter number (1, 2, 3, or 4) for the reporting period. Value must be a floating point number. + * @param {number} [fiscalQuarterGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [fiscalQuarterGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [fiscalQuarterLt] Filter less than the value. Value must be a floating point number. + * @param {number} [fiscalQuarterLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {string} [timeframe] The reporting period type. Possible values include: quarterly, annual, trailing_twelve_months. + * @param {string} [timeframeAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [timeframeGt] Filter greater than the value. + * @param {string} [timeframeGte] Filter greater than or equal to the value. + * @param {string} [timeframeLt] Filter less than the value. + * @param {string} [timeframeLte] Filter less than or equal to the value. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'period_end\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public getStocksFinancialsV1IncomeStatements(cik?: string, cikAnyOf?: string, cikGt?: string, cikGte?: string, cikLt?: string, cikLte?: string, tickers?: string, tickersAllOf?: string, tickersAnyOf?: string, periodEnd?: string, periodEndGt?: string, periodEndGte?: string, periodEndLt?: string, periodEndLte?: string, filingDate?: string, filingDateGt?: string, filingDateGte?: string, filingDateLt?: string, filingDateLte?: string, fiscalYear?: number, fiscalYearGt?: number, fiscalYearGte?: number, fiscalYearLt?: number, fiscalYearLte?: number, fiscalQuarter?: number, fiscalQuarterGt?: number, fiscalQuarterGte?: number, fiscalQuarterLt?: number, fiscalQuarterLte?: number, timeframe?: string, timeframeAnyOf?: string, timeframeGt?: string, timeframeGte?: string, timeframeLt?: string, timeframeLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).getStocksFinancialsV1IncomeStatements(cik, cikAnyOf, cikGt, cikGte, cikLt, cikLte, tickers, tickersAllOf, tickersAnyOf, periodEnd, periodEndGt, periodEndGte, periodEndLt, periodEndLte, filingDate, filingDateGt, filingDateGte, filingDateLt, filingDateLte, fiscalYear, fiscalYearGt, fiscalYearGte, fiscalYearLt, fiscalYearLte, fiscalQuarter, fiscalQuarterGt, fiscalQuarterGte, fiscalQuarterLt, fiscalQuarterLte, timeframe, timeframeAnyOf, timeframeGt, timeframeGte, timeframeLt, timeframeLte, limit, sort, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * A comprehensive financial ratios dataset providing key valuation, profitability, liquidity, and leverage metrics for public companies. Combines data from income statements, balance sheets, and cash flow statements with daily stock prices to calculate ratios on a daily basis. Uses trailing twelve months (TTM) data for income/cash flow metrics and quarterly data for balance sheet items. Fundamental data updates are applied starting from each filing\'s period end date. Market cap calculations use point-in-time shares outstanding for historical accuracy. + * @param {string} [ticker] Stock ticker symbol for the company. + * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [tickerGt] Filter greater than the value. + * @param {string} [tickerGte] Filter greater than or equal to the value. + * @param {string} [tickerLt] Filter less than the value. + * @param {string} [tickerLte] Filter less than or equal to the value. + * @param {string} [cik] Central Index Key (CIK) number assigned by the SEC to identify the company. + * @param {string} [cikAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. + * @param {string} [cikGt] Filter greater than the value. + * @param {string} [cikGte] Filter greater than or equal to the value. + * @param {string} [cikLt] Filter less than the value. + * @param {string} [cikLte] Filter less than or equal to the value. + * @param {number} [price] Stock price used in ratio calculations, typically the closing price for the given date. Value must be a floating point number. + * @param {number} [priceGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [priceGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [priceLt] Filter less than the value. Value must be a floating point number. + * @param {number} [priceLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [averageVolume] Average trading volume over the last 30 trading days, providing context for liquidity. Value must be a floating point number. + * @param {number} [averageVolumeGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [averageVolumeGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [averageVolumeLt] Filter less than the value. Value must be a floating point number. + * @param {number} [averageVolumeLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [marketCap] Market capitalization, calculated as stock price multiplied by total shares outstanding. Value must be a floating point number. + * @param {number} [marketCapGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [marketCapGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [marketCapLt] Filter less than the value. Value must be a floating point number. + * @param {number} [marketCapLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [earningsPerShare] Earnings per share, calculated as net income available to common shareholders divided by weighted shares outstanding. Value must be a floating point number. + * @param {number} [earningsPerShareGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [earningsPerShareGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [earningsPerShareLt] Filter less than the value. Value must be a floating point number. + * @param {number} [earningsPerShareLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [priceToEarnings] Price-to-earnings ratio, calculated as stock price divided by earnings per share. Only calculated when earnings per share is positive. Value must be a floating point number. + * @param {number} [priceToEarningsGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [priceToEarningsGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [priceToEarningsLt] Filter less than the value. Value must be a floating point number. + * @param {number} [priceToEarningsLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [priceToBook] Price-to-book ratio, calculated as stock price divided by book value per share, comparing market value to book value. Value must be a floating point number. + * @param {number} [priceToBookGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [priceToBookGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [priceToBookLt] Filter less than the value. Value must be a floating point number. + * @param {number} [priceToBookLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [priceToSales] Price-to-sales ratio, calculated as stock price divided by revenue per share, measuring valuation relative to sales. Value must be a floating point number. + * @param {number} [priceToSalesGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [priceToSalesGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [priceToSalesLt] Filter less than the value. Value must be a floating point number. + * @param {number} [priceToSalesLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [priceToCashFlow] Price-to-cash-flow ratio, calculated as stock price divided by operating cash flow per share. Only calculated when operating cash flow per share is positive. Value must be a floating point number. + * @param {number} [priceToCashFlowGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [priceToCashFlowGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [priceToCashFlowLt] Filter less than the value. Value must be a floating point number. + * @param {number} [priceToCashFlowLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [priceToFreeCashFlow] Price-to-free-cash-flow ratio, calculated as stock price divided by free cash flow per share. Only calculated when free cash flow per share is positive. Value must be a floating point number. + * @param {number} [priceToFreeCashFlowGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [priceToFreeCashFlowGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [priceToFreeCashFlowLt] Filter less than the value. Value must be a floating point number. + * @param {number} [priceToFreeCashFlowLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [dividendYield] Dividend yield, calculated as annual dividends per share divided by stock price, measuring the income return on investment. Value must be a floating point number. + * @param {number} [dividendYieldGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [dividendYieldGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [dividendYieldLt] Filter less than the value. Value must be a floating point number. + * @param {number} [dividendYieldLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [returnOnAssets] Return on assets ratio, calculated as net income divided by total assets, measuring how efficiently a company uses its assets to generate profit. Value must be a floating point number. + * @param {number} [returnOnAssetsGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [returnOnAssetsGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [returnOnAssetsLt] Filter less than the value. Value must be a floating point number. + * @param {number} [returnOnAssetsLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [returnOnEquity] Return on equity ratio, calculated as net income divided by total shareholders\' equity, measuring profitability relative to shareholders\' equity. Value must be a floating point number. + * @param {number} [returnOnEquityGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [returnOnEquityGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [returnOnEquityLt] Filter less than the value. Value must be a floating point number. + * @param {number} [returnOnEquityLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [debtToEquity] Debt-to-equity ratio, calculated as total debt (current debt plus long-term debt) divided by total shareholders\' equity, measuring financial leverage. Value must be a floating point number. + * @param {number} [debtToEquityGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [debtToEquityGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [debtToEquityLt] Filter less than the value. Value must be a floating point number. + * @param {number} [debtToEquityLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [current] Current ratio, calculated as total current assets divided by total current liabilities, measuring short-term liquidity. Value must be a floating point number. + * @param {number} [currentGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [currentGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [currentLt] Filter less than the value. Value must be a floating point number. + * @param {number} [currentLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [quick] Quick ratio (acid-test ratio), calculated as (current assets minus inventories) divided by current liabilities, measuring immediate liquidity. Value must be a floating point number. + * @param {number} [quickGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [quickGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [quickLt] Filter less than the value. Value must be a floating point number. + * @param {number} [quickLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [cash] Cash ratio, calculated as cash and cash equivalents divided by current liabilities, measuring the most liquid form of liquidity coverage. Value must be a floating point number. + * @param {number} [cashGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [cashGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [cashLt] Filter less than the value. Value must be a floating point number. + * @param {number} [cashLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [evToSales] Enterprise value to sales ratio, calculated as enterprise value divided by revenue, measuring company valuation relative to sales. Value must be a floating point number. + * @param {number} [evToSalesGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [evToSalesGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [evToSalesLt] Filter less than the value. Value must be a floating point number. + * @param {number} [evToSalesLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [evToEbitda] Enterprise value to EBITDA ratio, calculated as enterprise value divided by EBITDA, measuring company valuation relative to earnings before interest, taxes, depreciation, and amortization. Value must be a floating point number. + * @param {number} [evToEbitdaGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [evToEbitdaGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [evToEbitdaLt] Filter less than the value. Value must be a floating point number. + * @param {number} [evToEbitdaLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [enterpriseValue] Enterprise value, calculated as market capitalization plus total debt minus cash and cash equivalents, representing total company value. Value must be a floating point number. + * @param {number} [enterpriseValueGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [enterpriseValueGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [enterpriseValueLt] Filter less than the value. Value must be a floating point number. + * @param {number} [enterpriseValueLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [freeCashFlow] Free cash flow, calculated as operating cash flow minus capital expenditures (purchase of property, plant, and equipment). Value must be a floating point number. + * @param {number} [freeCashFlowGt] Filter greater than the value. Value must be a floating point number. + * @param {number} [freeCashFlowGte] Filter greater than or equal to the value. Value must be a floating point number. + * @param {number} [freeCashFlowLt] Filter less than the value. Value must be a floating point number. + * @param {number} [freeCashFlowLte] Filter less than or equal to the value. Value must be a floating point number. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'50000\'. + * @param {string} [sort] A comma separated list of sort columns. For each column, append \'.asc\' or \'.desc\' to specify the sort direction. The sort column defaults to \'ticker\' if not specified. The sort order defaults to \'asc\' if not specified. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public getStocksFinancialsV1Ratios(ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, cik?: string, cikAnyOf?: string, cikGt?: string, cikGte?: string, cikLt?: string, cikLte?: string, price?: number, priceGt?: number, priceGte?: number, priceLt?: number, priceLte?: number, averageVolume?: number, averageVolumeGt?: number, averageVolumeGte?: number, averageVolumeLt?: number, averageVolumeLte?: number, marketCap?: number, marketCapGt?: number, marketCapGte?: number, marketCapLt?: number, marketCapLte?: number, earningsPerShare?: number, earningsPerShareGt?: number, earningsPerShareGte?: number, earningsPerShareLt?: number, earningsPerShareLte?: number, priceToEarnings?: number, priceToEarningsGt?: number, priceToEarningsGte?: number, priceToEarningsLt?: number, priceToEarningsLte?: number, priceToBook?: number, priceToBookGt?: number, priceToBookGte?: number, priceToBookLt?: number, priceToBookLte?: number, priceToSales?: number, priceToSalesGt?: number, priceToSalesGte?: number, priceToSalesLt?: number, priceToSalesLte?: number, priceToCashFlow?: number, priceToCashFlowGt?: number, priceToCashFlowGte?: number, priceToCashFlowLt?: number, priceToCashFlowLte?: number, priceToFreeCashFlow?: number, priceToFreeCashFlowGt?: number, priceToFreeCashFlowGte?: number, priceToFreeCashFlowLt?: number, priceToFreeCashFlowLte?: number, dividendYield?: number, dividendYieldGt?: number, dividendYieldGte?: number, dividendYieldLt?: number, dividendYieldLte?: number, returnOnAssets?: number, returnOnAssetsGt?: number, returnOnAssetsGte?: number, returnOnAssetsLt?: number, returnOnAssetsLte?: number, returnOnEquity?: number, returnOnEquityGt?: number, returnOnEquityGte?: number, returnOnEquityLt?: number, returnOnEquityLte?: number, debtToEquity?: number, debtToEquityGt?: number, debtToEquityGte?: number, debtToEquityLt?: number, debtToEquityLte?: number, current?: number, currentGt?: number, currentGte?: number, currentLt?: number, currentLte?: number, quick?: number, quickGt?: number, quickGte?: number, quickLt?: number, quickLte?: number, cash?: number, cashGt?: number, cashGte?: number, cashLt?: number, cashLte?: number, evToSales?: number, evToSalesGt?: number, evToSalesGte?: number, evToSalesLt?: number, evToSalesLte?: number, evToEbitda?: number, evToEbitdaGt?: number, evToEbitdaGte?: number, evToEbitdaLt?: number, evToEbitdaLte?: number, enterpriseValue?: number, enterpriseValueGt?: number, enterpriseValueGte?: number, enterpriseValueLt?: number, enterpriseValueLte?: number, freeCashFlow?: number, freeCashFlowGt?: number, freeCashFlowGte?: number, freeCashFlowLt?: number, freeCashFlowLte?: number, limit?: number, sort?: string, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).getStocksFinancialsV1Ratios(ticker, tickerAnyOf, tickerGt, tickerGte, tickerLt, tickerLte, cik, cikAnyOf, cikGt, cikGte, cikLt, cikLte, price, priceGt, priceGte, priceLt, priceLte, averageVolume, averageVolumeGt, averageVolumeGte, averageVolumeLt, averageVolumeLte, marketCap, marketCapGt, marketCapGte, marketCapLt, marketCapLte, earningsPerShare, earningsPerShareGt, earningsPerShareGte, earningsPerShareLt, earningsPerShareLte, priceToEarnings, priceToEarningsGt, priceToEarningsGte, priceToEarningsLt, priceToEarningsLte, priceToBook, priceToBookGt, priceToBookGte, priceToBookLt, priceToBookLte, priceToSales, priceToSalesGt, priceToSalesGte, priceToSalesLt, priceToSalesLte, priceToCashFlow, priceToCashFlowGt, priceToCashFlowGte, priceToCashFlowLt, priceToCashFlowLte, priceToFreeCashFlow, priceToFreeCashFlowGt, priceToFreeCashFlowGte, priceToFreeCashFlowLt, priceToFreeCashFlowLte, dividendYield, dividendYieldGt, dividendYieldGte, dividendYieldLt, dividendYieldLte, returnOnAssets, returnOnAssetsGt, returnOnAssetsGte, returnOnAssetsLt, returnOnAssetsLte, returnOnEquity, returnOnEquityGt, returnOnEquityGte, returnOnEquityLt, returnOnEquityLte, debtToEquity, debtToEquityGt, debtToEquityGte, debtToEquityLt, debtToEquityLte, current, currentGt, currentGte, currentLt, currentLte, quick, quickGt, quickGte, quickLt, quickLte, cash, cashGt, cashGte, cashLt, cashLte, evToSales, evToSalesGt, evToSalesGte, evToSalesLt, evToSalesLte, evToEbitda, evToEbitdaGt, evToEbitdaGte, evToEbitdaLt, evToEbitdaLte, enterpriseValue, enterpriseValueGt, enterpriseValueGte, enterpriseValueLt, enterpriseValueLte, freeCashFlow, freeCashFlowGt, freeCashFlowGte, freeCashFlowLt, freeCashFlowLte, limit, sort, options).then((request) => request(this.axios, this.basePath)); + } + /** * Get moving average convergence/divergence (MACD) data for a ticker symbol over a given time range. * @summary Moving Average Convergence/Divergence (MACD) @@ -28251,7 +36877,18 @@ export class DefaultApi extends BaseAPI { } /** - * + * US stock exchanges, trading venues, and reporting facilities including exchanges (NYSE, Nasdaq), Trade Reporting Facilities (TRF), Securities Information Processors (SIP), and OTC Reporting Facilities (ORF) for equity trading. + * @param {number} [limit] Limit the maximum number of results returned. Defaults to \'100\' if not specified. The maximum allowed limit is \'999\'. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public getStocksV1Exchanges(limit?: number, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).getStocksV1Exchanges(limit, options).then((request) => request(this.axios, this.basePath)); + } + + /** + * Comprehensive FINRA short interest data that tracks the short selling metrics for securities on a specific settlement date. * @param {string} [ticker] The primary ticker symbol for the stock. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. @@ -28287,7 +36924,7 @@ export class DefaultApi extends BaseAPI { } /** - * + * Contains short selling volume for different stock tickers, capturing total trading volume, short sale details, and breakdown by different trading platforms. * @param {string} [ticker] The primary ticker symbol for the stock. * @param {string} [tickerAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [tickerGt] Filter greater than the value. @@ -28323,7 +36960,7 @@ export class DefaultApi extends BaseAPI { } /** - * Get a single ticker supported by Polygon.io. This response will have detailed information about the ticker and the company behind it. + * Get a single ticker supported by Massive.com. This response will have detailed information about the ticker and the company behind it. * @summary Ticker Details v3 * @param {string} ticker Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. * @param {string} [date] Specify a point in time to get information about the ticker available on that date. When retrieving information from SEC filings, we compare this date with the period of report date on the SEC filing. For example, consider an SEC filing submitted by AAPL on 2019-07-31, with a period of report date ending on 2019-06-29. That means that the filing was submitted on 2019-07-31, but the filing was created based on information from 2019-06-29. If you were to query for AAPL details on 2019-06-29, the ticker details would include information from the SEC filing. Defaults to the most recent available date. @@ -28336,7 +36973,7 @@ export class DefaultApi extends BaseAPI { } /** - * + * Contains corporate events and announcements for publicly traded companies, including earnings releases, conferences, dividends, and business updates sourced from TMX. * @param {string} [date] Scheduled date of the corporate event, formatted as YYYY-MM-DD. * @param {string} [dateAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. * @param {string} [dateGt] Filter greater than the value. @@ -28374,7 +37011,6 @@ export class DefaultApi extends BaseAPI { * @param {string} [tradingVenueLt] Filter less than the value. * @param {string} [tradingVenueLte] Filter less than or equal to the value. * @param {number} [tmxCompanyId] Unique numeric identifier for the company used by TMX. Value must be an integer. - * @param {string} [tmxCompanyIdAnyOf] Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Value must be an integer. * @param {number} [tmxCompanyIdGt] Filter greater than the value. Value must be an integer. * @param {number} [tmxCompanyIdGte] Filter greater than or equal to the value. Value must be an integer. * @param {number} [tmxCompanyIdLt] Filter less than the value. Value must be an integer. @@ -28391,12 +37027,12 @@ export class DefaultApi extends BaseAPI { * @throws {RequiredError} * @memberof DefaultApi */ - public getTmxV1CorporateEvents(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, type?: string, typeAnyOf?: string, typeGt?: string, typeGte?: string, typeLt?: string, typeLte?: string, status?: string, statusAnyOf?: string, statusGt?: string, statusGte?: string, statusLt?: string, statusLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, isin?: string, isinAnyOf?: string, isinGt?: string, isinGte?: string, isinLt?: string, isinLte?: string, tradingVenue?: string, tradingVenueAnyOf?: string, tradingVenueGt?: string, tradingVenueGte?: string, tradingVenueLt?: string, tradingVenueLte?: string, tmxCompanyId?: number, tmxCompanyIdAnyOf?: string, tmxCompanyIdGt?: number, tmxCompanyIdGte?: number, tmxCompanyIdLt?: number, tmxCompanyIdLte?: number, tmxRecordId?: string, tmxRecordIdAnyOf?: string, tmxRecordIdGt?: string, tmxRecordIdGte?: string, tmxRecordIdLt?: string, tmxRecordIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig) { - return DefaultApiFp(this.configuration).getTmxV1CorporateEvents(date, dateAnyOf, dateGt, dateGte, dateLt, dateLte, type, typeAnyOf, typeGt, typeGte, typeLt, typeLte, status, statusAnyOf, statusGt, statusGte, statusLt, statusLte, ticker, tickerAnyOf, tickerGt, tickerGte, tickerLt, tickerLte, isin, isinAnyOf, isinGt, isinGte, isinLt, isinLte, tradingVenue, tradingVenueAnyOf, tradingVenueGt, tradingVenueGte, tradingVenueLt, tradingVenueLte, tmxCompanyId, tmxCompanyIdAnyOf, tmxCompanyIdGt, tmxCompanyIdGte, tmxCompanyIdLt, tmxCompanyIdLte, tmxRecordId, tmxRecordIdAnyOf, tmxRecordIdGt, tmxRecordIdGte, tmxRecordIdLt, tmxRecordIdLte, limit, sort, options).then((request) => request(this.axios, this.basePath)); + public getTmxV1CorporateEvents(date?: string, dateAnyOf?: string, dateGt?: string, dateGte?: string, dateLt?: string, dateLte?: string, type?: string, typeAnyOf?: string, typeGt?: string, typeGte?: string, typeLt?: string, typeLte?: string, status?: string, statusAnyOf?: string, statusGt?: string, statusGte?: string, statusLt?: string, statusLte?: string, ticker?: string, tickerAnyOf?: string, tickerGt?: string, tickerGte?: string, tickerLt?: string, tickerLte?: string, isin?: string, isinAnyOf?: string, isinGt?: string, isinGte?: string, isinLt?: string, isinLte?: string, tradingVenue?: string, tradingVenueAnyOf?: string, tradingVenueGt?: string, tradingVenueGte?: string, tradingVenueLt?: string, tradingVenueLte?: string, tmxCompanyId?: number, tmxCompanyIdGt?: number, tmxCompanyIdGte?: number, tmxCompanyIdLt?: number, tmxCompanyIdLte?: number, tmxRecordId?: string, tmxRecordIdAnyOf?: string, tmxRecordIdGt?: string, tmxRecordIdGte?: string, tmxRecordIdLt?: string, tmxRecordIdLte?: string, limit?: number, sort?: string, options?: RawAxiosRequestConfig) { + return DefaultApiFp(this.configuration).getTmxV1CorporateEvents(date, dateAnyOf, dateGt, dateGte, dateLt, dateLte, type, typeAnyOf, typeGt, typeGte, typeLt, typeLte, status, statusAnyOf, statusGt, statusGte, statusLt, statusLte, ticker, tickerAnyOf, tickerGt, tickerGte, tickerLt, tickerLte, isin, isinAnyOf, isinGt, isinGte, isinLt, isinLte, tradingVenue, tradingVenueAnyOf, tradingVenueGt, tradingVenueGte, tradingVenueLt, tradingVenueLte, tmxCompanyId, tmxCompanyIdGt, tmxCompanyIdGte, tmxCompanyIdLt, tmxCompanyIdLte, tmxRecordId, tmxRecordIdAnyOf, tmxRecordIdGt, tmxRecordIdGte, tmxRecordIdLt, tmxRecordIdLte, limit, sort, options).then((request) => request(this.axios, this.basePath)); } /** - * List all conditions that Polygon.io uses. + * List all conditions that Massive.com uses. * @summary Conditions * @param {ListConditionsAssetClassEnum} [assetClass] Filter for conditions within a given asset class. * @param {ListConditionsDataTypeEnum} [dataType] Filter by data type. @@ -28460,7 +37096,7 @@ export class DefaultApi extends BaseAPI { } /** - * List all exchanges that Polygon.io knows about. + * List all exchanges that Massive.com knows about. * @summary Exchanges * @param {ListExchangesAssetClassEnum} [assetClass] Filter by asset class. * @param {ListExchangesLocaleEnum} [locale] Filter by locale. @@ -28554,7 +37190,7 @@ export class DefaultApi extends BaseAPI { * Query for historical options contracts. This provides both active and expired options contracts. * @summary Options Contracts * @param {string} [underlyingTicker] Query for contracts relating to an underlying stock ticker. - * @param {string} [ticker] This parameter has been deprecated. To search by specific options ticker, use the Options Contract endpoint [here](https://polygon.io/docs/options/get_v3_reference_options_contracts__options_ticker). + * @param {string} [ticker] This parameter has been deprecated. To search by specific options ticker, use the Options Contract endpoint [here](https://massive.com/docs/options/get_v3_reference_options_contracts__options_ticker). * @param {ListOptionsContractsContractTypeEnum} [contractType] Query by the type of contract. * @param {string} [expirationDate] Query by contract expiration with date format YYYY-MM-DD. * @param {string} [asOf] Specify a point in time for contracts as of this date with format YYYY-MM-DD. Defaults to today\'s date. @@ -28609,7 +37245,7 @@ export class DefaultApi extends BaseAPI { } /** - * List all ticker types that Polygon.io has. + * List all ticker types that Massive.com has. * @summary Ticker Types * @param {ListTickerTypesAssetClassEnum} [assetClass] Filter by asset class. * @param {ListTickerTypesLocaleEnum} [locale] Filter by locale. @@ -28622,10 +37258,10 @@ export class DefaultApi extends BaseAPI { } /** - * Query all ticker symbols which are supported by Polygon.io. This API currently includes Stocks/Equities, Indices, Forex, and Crypto. + * Query all ticker symbols which are supported by Massive.com. This API currently includes Stocks/Equities, Indices, Forex, and Crypto. * @summary Tickers * @param {string} [ticker] Specify a ticker symbol. Defaults to empty string which queries all tickers. - * @param {ListTickersTypeEnum} [type] Specify the type of the tickers. Find the types that we support via our [Ticker Types API](https://polygon.io/docs/stocks/get_v3_reference_tickers_types). Defaults to empty string which queries all types. + * @param {ListTickersTypeEnum} [type] Specify the type of the tickers. Find the types that we support via our [Ticker Types API](https://massive.com/docs/stocks/get_v3_reference_tickers_types). Defaults to empty string which queries all types. * @param {ListTickersMarketEnum} [market] Filter by market type. By default all markets are included. * @param {string} [exchange] Specify the asset\'s primary exchange Market Identifier Code (MIC) according to [ISO 10383](https://www.iso20022.org/market-identifier-codes). Defaults to empty string which queries all exchanges. * @param {string} [cusip] Specify the CUSIP code of the asset you want to search for. Find more information about CUSIP codes [at their website](https://www.cusip.com/identifiers.html#/CUSIP). Defaults to empty string which queries all CUSIPs. Note: Although you can query by CUSIP, due to legal reasons we do not return the CUSIP in the response. diff --git a/src/rest/base.ts b/src/rest/base.ts index e61c02c..ce9254e 100644 --- a/src/rest/base.ts +++ b/src/rest/base.ts @@ -19,7 +19,7 @@ import type { Configuration } from './configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import globalAxios from 'axios'; -export const BASE_PATH = "https://api.polygon.io".replace(/\/+$/, ""); +export const BASE_PATH = "https://api.massive.com".replace(/\/+$/, ""); /** * diff --git a/src/websockets/crypto/index.ts b/src/websockets/crypto/index.ts index 87cd5c7..0dc56a5 100644 --- a/src/websockets/crypto/index.ts +++ b/src/websockets/crypto/index.ts @@ -24,7 +24,7 @@ export interface ITradeCryptoEvent { c: number[]; // Condition i: string; // Trade ID ( Optional ) x: number; // Exchange ID - r: number; // Received @ Polygon Timestamp + r: number; // Received @ Massive Timestamp } // Crypto Quote: @@ -37,7 +37,7 @@ export interface IQuoteCryptoEvent { as: number; // Ask Size t: number; // Exchange Timestamp Unix ( ms ) x: number; // Exchange ID - r: number; // Received @ Polygon Timestamp + r: number; // Received @ Massive Timestamp } // Crypto FMV: @@ -50,5 +50,5 @@ export interface IFMVCryptoEvent { export const getCryptoWebsocket = ( apiKey: string, - apiBase = "wss://socket.polygon.io" + apiBase = "wss://socket.massive.com" ): websocket.w3cwebsocket => getWsClient(`${apiBase}/crypto`, apiKey); diff --git a/src/websockets/forex/index.ts b/src/websockets/forex/index.ts index f0c332a..9c34d4c 100644 --- a/src/websockets/forex/index.ts +++ b/src/websockets/forex/index.ts @@ -34,5 +34,5 @@ export interface IFMVForexEvent { export const getForexWebsocket = ( apiKey: string, - apiBase = "wss://socket.polygon.io" + apiBase = "wss://socket.massive.com" ): websocket.w3cwebsocket => getWsClient(`${apiBase}/forex`, apiKey); diff --git a/src/websockets/futures/index.ts b/src/websockets/futures/index.ts index dc6cef4..3fa1553 100644 --- a/src/websockets/futures/index.ts +++ b/src/websockets/futures/index.ts @@ -41,6 +41,6 @@ export interface IQuoteFuturesEvent { export const getFuturesWebsocket = ( apiKey: string, - apiBase = "wss://socket.polygon.io", + apiBase = "wss://socket.massive.com", exchange?: string ): websocket.w3cwebsocket => getWsClient(`${apiBase}/futures${exchange ? `/${exchange}` : ""}`, apiKey); diff --git a/src/websockets/indices/index.ts b/src/websockets/indices/index.ts index f8d2090..6739bdb 100644 --- a/src/websockets/indices/index.ts +++ b/src/websockets/indices/index.ts @@ -24,5 +24,5 @@ export interface IIndexValueEvent { export const getIndicesWebsocket = ( apiKey: string, - apiBase = "wss://socket.polygon.io" + apiBase = "wss://socket.massive.com" ): websocket.w3cwebsocket => getWsClient(`${apiBase}/indices`, apiKey); diff --git a/src/websockets/options/index.ts b/src/websockets/options/index.ts index eec9e7c..2131f2b 100644 --- a/src/websockets/options/index.ts +++ b/src/websockets/options/index.ts @@ -55,5 +55,5 @@ export interface IFMVOptionsEvent { export const getOptionsWebsocket = ( apiKey: string, - apiBase = "wss://socket.polygon.io" + apiBase = "wss://socket.massive.com" ): websocket.w3cwebsocket => getWsClient(`${apiBase}/options`, apiKey); diff --git a/src/websockets/stocks/index.ts b/src/websockets/stocks/index.ts index fe7f11b..966828f 100644 --- a/src/websockets/stocks/index.ts +++ b/src/websockets/stocks/index.ts @@ -83,5 +83,5 @@ export interface IFMVStockEvent { export const getStocksWebsocket = ( apiKey: string, - apiBase = "wss://socket.polygon.io" + apiBase = "wss://socket.massive.com" ): websocket.w3cwebsocket => getWsClient(`${apiBase}/stocks`, apiKey); From 98b555f30e49ef2ece66a1ca8db84c2e00d37a60 Mon Sep 17 00:00:00 2001 From: justinpolygon <123573436+justinpolygon@users.noreply.github.com> Date: Mon, 24 Nov 2025 10:56:32 -0800 Subject: [PATCH 2/3] Update scripts/pull_spec.js Co-authored-by: juliedriscoll <392830+penelopus@users.noreply.github.com> --- scripts/pull_spec.js | 2 -- 1 file changed, 2 deletions(-) diff --git a/scripts/pull_spec.js b/scripts/pull_spec.js index 9f08657..05a4501 100644 --- a/scripts/pull_spec.js +++ b/scripts/pull_spec.js @@ -31,8 +31,6 @@ const main = async () => { // Skip paths marked as drafts if (pathObj["x-polygon-draft"]) continue; - // Skip paths starting with /v1/reference/ - if (path.startsWith('/v1/reference/')) continue; // Since all endpoints use GET, process the 'get' method const operation = pathObj.get; From 3cc1f864f655a0f6f67be7950cc30853effef051 Mon Sep 17 00:00:00 2001 From: justinpolygon <123573436+justinpolygon@users.noreply.github.com> Date: Mon, 24 Nov 2025 10:59:04 -0800 Subject: [PATCH 3/3] added options and futures --- package.json | 2 ++ 1 file changed, 2 insertions(+) diff --git a/package.json b/package.json index 2535376..968d19d 100644 --- a/package.json +++ b/package.json @@ -28,6 +28,8 @@ "massive.com", "stock api", "options api", + "indices api", + "futures api", "forex api", "crypto api" ],