@massive.com/client-js 9.0.0

package/CHANGELOG.md

@@ -0,0 +1,129 @@
+## [8.0.0](https://github.com/massive.com/client-js/compare/v7.4.0...v8.0.0) (2025-06-21)
+### Breaking Changes
+* Functions call naming has updated to new autogenerated standards w/ all rest client
+* Debug mode has been deprecated from `globalFetchOptions`
+
+## [7.3.2](https://github.com/massive.com/client-js/compare/v7.3.1...v7.3.2) (2023-10-05)
+### Bug Fixes
+* Rearrange request config types so they inherit global options for pagination and trace
+
+## [7.3.1](https://github.com/massive.com/client-js/compare/v7.3.0...v7.3.1) (2023-09-15)
+### Bug Fixes
+* Fix unintended change to top level response object that returned results array instead of results object
+
+### Other Changes
+* Improved test coverage for response object
+
+## [7.3.0](https://github.com/massive.com/client-js/compare/v7.2.6...v7.3.0) (2023-09-11)
+### New Feature
+* Update README with pagination and trace modes
+* Added request tracing and API pagination support
+
+## [7.2.6](https://github.com/massive.com/client-js/compare/v7.2.5...v7.2.6) (2023-08-11)
+### Bug Fixes
+* Export universal snapshot types
+* Add next_url to Aggregates enpdoints response types
+* Update examples to use import syntax instead of require
+
+## [7.2.4](https://github.com/massive.com/client-js/compare/v7.2.3...v7.2.4) (2023-06-14)
+### Bug Fixes
+* Update snapshot min to support n and t
+* Exports and Updates Options WebSocket Event Types
+* Universal snapshot
+
+## [7.2.3](https://github.com/massive.com/client-js/compare/v7.2.2...v7.2.3) (2023-05-15)
+### Bug Fixes
+* Fix typing issue with optional headers Launchpad Typescript definitions
+* Export types from requests file
+* Make Launchpad Headers optional to support metered product
+
+## [7.2.2](https://github.com/massive.com/client-js/compare/v7.2.1...v7.2.2) (2023-04-19)
+### Bug Fixes
+* Remove examples and unneccesary files from npm package
+
+## [7.2.1](https://github.com/massive.com/client-js/compare/v7.2.0...v7.2.1) (2023-04-12)
+### Bug Fixes
+* Update snapshot response type to reflect recent additions
+
+## [7.2.0](https://github.com/massive.com/client-js/compare/v7.1.1...v7.2.0) (2023-04-07)
+### New Feature
+* Support Dual Module Formats so that this package can be used with CommonJS 
+
+## [7.1.1](https://github.com/massive.com/client-js/v7.0.1...v7.1.1) (2023-03-20)
+
+### Bug Fixes
+* Fix misspelled filling_url to filing_url
+* Preserve JSON errors returned from the server
+
+## [7.1.0](https://github.com/massive.com/client-js/compare/v7.0.3...v7.1.0) (2023-03-13)
+### New Feature
+* Indices
+
+## [7.0.3](https://github.com/massive.com/client-js/v7.0.2...v7.0.3) (2023-02-21)
+
+### Bug Fixes
+* Fix grouped daily forex url
+
+## [7.0.2](https://github.com/massive.com/client-js/v7.0.1...v7.0.2) (2023-02-15)
+
+### Bug Fixes
+* Wrap fetch call in try/catch and bubble up network errors
+
+## [6.2.1](https://github.com/massive.com/client-js/v6.2.0...v6.2.1) (2023-02-15)
+
+### Bug Fixes
+* Wrap fetch call in try/catch and bubble up network errors
+
+## [7.0.1](https://github.com/massive.com/client-js/v7.0.0...v7.0.1) (2023-02-01)
+
+### Bug Fixes
+* Add ticker_root, postal_code, and round_lot attributes to the Ticker Details response types
+
+
+## [7.0.0](https://github.com/massive.com/client-js/v6.2.0...v7.0.0) (2023-01-25)
+
+> Description
+
+### Upgrade Steps
+
+#### Node Version
+To use this version in a node project you will need to use node 16 or above. This change was made to support exporting ES Modules instead of CommonJS Modules. The ES Modules exported by this package should be fully supported in Node 16+.
+
+#### Headers and Request Options
+The headers parameter has been replaced with a request options parameter which accepts headers. If you were passing headers to an endpoint, your code should change from
+
+```javascript
+rest.forex.previousClose("C:EURUSD", {}, myHeadersObject)
+```
+
+to
+
+```javascript
+rest.forex.previousClose("C:EURUSD", {}, { headers: myHeadersObject })
+```
+
+This change was made to allow additional request options to be passed to the request. You can pass any of the [available request options for fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch#supplying_request_options) in the request options object, and they will be passed through to the fetch request.
+
+You can also pass request options when initializing the client like:
+
+```javascript
+const rest = restClient("API KEY", "https://api.massive.com", { headers: myHeaders });
+```
+
+These will be applied to each request unless overridden by options passed directly to the endpoint function.
+
+You can find more examples in the [configuration examples file](./examples/rest/configuration.js).
+
+### Breaking Changes
+* Node 16+ compilation target
+* Pass entire request options as optional parameter instead of just headers
+
+### New Features
+* Allow request options to be passed globally to the client, or individually to endpoint functions
+
+### Bug Fixes
+* Pass api key in header instead of query parameter to improve security
+
+### Other Changes
+* Improved test coverage
+* Additional examples

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Polygon.io
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,122 @@
+# Massive JS Client
+
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+
+Welcome to the official JS client library for the [Massive](https://massive.com/) REST and WebSocket API. To get started, please see the [Getting Started](https://massive.com/docs/stocks/getting-started) section in our documentation, view the [examples](./examples/) directory for code snippets, or the [blog post](https://massive.com/blog/javascript-stock-market-data/) with video tutorials to learn more. To generate the package documentation please run `npm run generate-doc`.
+
+For upgrade instructions please see the [Release Notes](./CHANGELOG.md).
+
+**Note:** Polygon.io has rebranded as [Massive.com](https://massive.com) on Oct 30, 2025. Existing API keys, accounts, and integrations continue to work exactly as before. The only change in this SDK is that it now defaults to the new API base at `api.massive.com`, while `api.polygon.io` remains supported for an extended period.
+
+For details, see our [rebrand announcement blog post](https://massive.com/blog/polygon-is-now-massive/) or open an issue / contact [support@massive.com](mailto:support@massive.com) if you have questions.
+
+## Getting the client
+
+To get started, you'll need to install the client library:
+
+```bash
+npm install --save '@massive.com/client-js'
+```
+
+Next, create a new client with your [API key](https://massive.com/dashboard/signup).
+
+```javascript
+import { restClient } from '@massive.com/client-js';
+const rest = restClient(process.env.POLY_API_KEY);
+```
+
+## Using the client
+
+After creating the client, making calls to the Massive API is easy. For example, here's how to get aggregates (bars):
+
+```javascript
+rest.getStocksAggregates("AAPL", 1, GetStocksAggregatesTimespanEnum.Day, "2023-01-01", "2023-04-14").then((response) => {
+	console.log(response);
+}).catch(e => {
+	console.error('An error happened:', e);
+});
+```
+
+Or, maybe you want to get the last trades or quotes for a ticker:
+
+```javascript
+// last trade
+rest.getLastStocksTrade("AAPL").then((response) => {
+	console.log(response);
+}).catch(e => {
+	console.error('An error happened:', e);
+});
+
+// last quote (NBBO)
+rest.getLastStocksQuote("AAPL").then((response) => {
+	console.log(response);
+}).catch(e => {
+	console.error('An error happened:', e);
+});
+```
+
+Finally, maybe you want a market-wide snapshot of all tickers:
+
+```javascript
+rest.getSnapshots().then((response) => {
+	console.log(response);
+}).catch(e => {
+	console.error('An error happened:', e);
+});
+```
+
+See [full examples](./examples/rest/) for more details on how to use this client effectively. 
+
+## Pagination
+
+The client can handle pagination for you through the `globalFetchOptions` by turning on the `pagination: true` option. The feature will automatically fetch all `next_url` pages of data when the API response indicates more data is available.
+
+```javascript
+import { restClient } from '@massive.com/client-js';
+
+const globalFetchOptions = {
+	pagination: true,
+};
+const rest = restClient(process.env.POLY_API_KEY, "https://api.massive.com", globalFetchOptions);
+
+rest.getStocksAggregates("AAPL", 1, GetStocksAggregatesTimespanEnum.Day, "2023-01-01", "2023-04-14").then((response) => {
+	const data = response.data; // convert axios-wrapped response
+	const resultCount = data.resultsCount;
+	console.log("Result count:", resultCount);
+}).catch(e => {
+	console.error('An error happened:', e);
+});
+```
+
+If there is a `next_url` field in the API response, the client will recursively fetch the next page for you, and then pass along the accumulated data.
+
+## WebSocket Client
+
+Import the [Websocket](https://massive.com/docs/stocks/ws_getting-started) client and models packages to get started. You can get preauthenticated [websocket clients](https://www.npmjs.com/package/websocket) for the 3 topics.
+
+```javascript
+import { websocketClient } from "@massive.com/client-js";
+const stocksWS = websocketClient(process.env.POLY_API_KEY, 'wss://delayed.massive.com').stocks();
+
+stocksWS.onmessage = ({response}) => {
+  const [message] = JSON.parse(response);
+
+  stocksWS.send('{"action":"subscribe", "params":"AM.MSFT,A.MSFT"}');
+
+  switch (message.ev) {
+    case "AM":
+      // your trade message handler
+      break;
+    case "A":
+      // your trade message handler
+      break;
+  }
+};
+
+stocksWS.send({ action: "subscribe", params: "T.MSFT" });
+```
+See [full examples](./examples/websocket/) for more details on how to use this client effectively.
+
+## Contributing
+
+If you found a bug or have an idea for a new feature, please first discuss it with us by [submitting a new issue](https://github.com/massive.com/client-js/issues/new/choose). We will respond to issues within at most 3 weeks. We're also open to volunteers if you want to submit a PR for any open issues but please discuss it with us beforehand. PRs that aren't linked to an existing issue or discussed with us ahead of time will generally be declined. If you have more general feedback or want to discuss using this client with other users, feel free to reach out on our [Slack channel](https://massive.com.slack.com/archives/C03FCSBSAFL).