{"_id":"@airnub/unusualwhales-api-client","name":"@airnub/unusualwhales-api-client","dist-tags":{"latest":"1.0.0-alpha.1"},"versions":{"1.0.0-alpha.1":{"name":"@airnub/unusualwhales-api-client","version":"1.0.0-alpha.1","description":"A client library for interacting with the UnusualWhales API, written in TypeScript","main":"dist/src/ApiClient.js","types":"dist/src/ApiClient.d.ts","scripts":{"build":"tsc","test":"jest"},"repository":{"type":"git","url":"git+https://github.com/airnub/unusualwhales-api-client.git"},"bugs":{"url":"https://github.com/airnub/unusualwhales-api-client/issues"},"keywords":["node","typescript","api","client","unusual-whales","unusualwhales","unusualwhales API"],"author":{"name":"Airnub Technologies LTD","email":"alan@airnub.io"},"contributors":[{"name":"Alan Gunning","email":"alan@airnub.io"}],"license":"MIT","dependencies":{"axios":"^1.5.1"},"devDependencies":{"@types/jest":"^29.5.6","@types/node":"^20.8.8","axios-mock-adapter":"^1.22.0","jest":"^29.7.0","ts-jest":"^29.1.1","ts-node":"^10.9.1","typescript":"^5.2.2"},"jest":{"preset":"ts-jest","testEnvironment":"node","collectCoverage":true},"_id":"@airnub/unusualwhales-api-client@1.0.0-alpha.1","gitHead":"3290754252e8f2887219d4f400a673e4aba83cd9","homepage":"https://github.com/airnub/unusualwhales-api-client#readme","_nodeVersion":"18.18.0","_npmVersion":"9.8.1","dist":{"integrity":"sha512-YQ9og5wQGw8ZDEqNFl4wOKflB5GkP0iFrBFv+mjvW+fUBcrh1vQLJ5zzbgsuuElr3rRgv1zZyZtz3ap5xxAD/w==","shasum":"df9cee1b119367f0c47e4e7e632e6fb6d8fc34c6","tarball":"https://registry.npmjs.org/@airnub/unusualwhales-api-client/-/unusualwhales-api-client-1.0.0-alpha.1.tgz","fileCount":23,"unpackedSize":43243,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDs7eFzoKsMfsNPj0r9ycAMomnwsuudYCerQyNGQYgdBQIgXrrbRqvxq9I7kwrZdmwWbsK/5PxjFU3a5m70Uo0mxJc="}]},"_npmUser":{"name":"alangunning","email":"alangunning@gmail.com"},"directories":{},"maintainers":[{"name":"alangunning","email":"alangunning@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/unusualwhales-api-client_1.0.0-alpha.1_1698349499422_0.5082999472438292"},"_hasShrinkwrap":false}},"time":{"created":"2023-10-26T19:44:59.319Z","1.0.0-alpha.1":"2023-10-26T19:44:59.634Z","modified":"2023-10-26T19:44:59.912Z"},"maintainers":[{"name":"alangunning","email":"alangunning@gmail.com"}],"description":"A client library for interacting with the UnusualWhales API, written in TypeScript","homepage":"https://github.com/airnub/unusualwhales-api-client#readme","keywords":["node","typescript","api","client","unusual-whales","unusualwhales","unusualwhales API"],"repository":{"type":"git","url":"git+https://github.com/airnub/unusualwhales-api-client.git"},"contributors":[{"name":"Alan Gunning","email":"alan@airnub.io"}],"author":{"name":"Airnub Technologies LTD","email":"alan@airnub.io"},"bugs":{"url":"https://github.com/airnub/unusualwhales-api-client/issues"},"license":"MIT","readme":"# UnusualWhales API Client (`unusualwhales-api-client`)\n\n## Description\n\nThis project is a client library to interact with the UnusualWhales API, written in TypeScript. It aims to simplify the process of making API calls by providing a set of well-defined methods for accessing various endpoints. This library can be used in both JavaScript and TypeScript projects. Using TypeScript enhances type safety, enabling more robust and error-free API interactions.\n\n## Setup\n\n### Installation\n\nTo install the package:\n\n```bash\nnpm install @airnub/unusualwhales-api-client\n```\n\n### Build (Only if you cloned the repository)\n\nTo build the TypeScript source code:\n\n```bash\nnpm run build\n```\n\n## Usage\n\n### Initialize the ApiClient Class\n\n```typescript\nconst api = new ApiClient({\n  token: 'your-bearer-token',\n});\n```\n\n### Fetch Net Premium Ticks for a Stock (Async/Await Example)\n\n```typescript\nconst response = await api.stock.getNetPremiumTicks('SPY');\n```\n\n### Fetch Net Premium Ticks for a Stock (Promise `.then()` Example)\n\n```typescript\napi.stock.getNetPremiumTicks('SPY')\n  .then((response) => {\n    // Your code here\n  })\n  .catch((error) => {\n    console.error('An error occurred:', error);\n  });\n```\n\n## Contribution\n\nContributions are welcome. Please fork this repository and submit your changes via a pull request.\n\n1. Fork the repository\n2. Create a new branch (`git checkout -b feature-branch`)\n3. Commit your changes (`git commit -m 'Add some feature'`)\n4. Push to the branch (`git push origin feature-branch`)\n5. Create a new Pull Request\n\n## Submitting Issues\n\nIf you encounter any issues or have questions, please use the [GitHub issues](https://github.com/airnub/unusualwhales-api-client/issues) page to report them. This helps us keep track of all the queries and solve them in an organized manner.\n\n## License\n\nThis project is licensed under the terms of the [MIT License](LICENSE).\n","readmeFilename":"README.md"}