From 42ff3f96a382190484e69179743de9a3df11275e Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Sat, 24 Jun 2023 11:10:25 -0400 Subject: [PATCH] docs: add service readme file --- docs/polygon.md | 21 +++++++++++++++++++++ src/services/polygon.ts | 5 +++++ 2 files changed, 26 insertions(+) create mode 100644 docs/polygon.md diff --git a/docs/polygon.md b/docs/polygon.md new file mode 100644 index 00000000..da672f97 --- /dev/null +++ b/docs/polygon.md @@ -0,0 +1,21 @@ +

Polygon.io Agentic Service

+ +## Intro + +[Polygon.io][polygon] is a powerful stock market data API provider that provides extensive APIs that range from the realtime and historical data on stocks, options, indices, forex, crypto. Built for developers by developers, Polygon.io is the ideal data provider for your next project. + +## Pre-requisites + +Ensure the following environment variable is set: + +- `POLYGON_API_KEY` - API key for Polygon.io. + +Otherwise, you can pass it in as an argument to the `PolygonClient ` constructor. + +### How to Retrieve API Key + +1. Open [Polygon.io][polygon] and sign up for an account or log in. +2. On the left side of the screen, click on the `API Keys` menu item. +3. Locate your API key and copy it to your clipboard by clicking on the respective button. + +[polygon]: https://polygon.io diff --git a/src/services/polygon.ts b/src/services/polygon.ts index 4ebe0c0a..727267d9 100644 --- a/src/services/polygon.ts +++ b/src/services/polygon.ts @@ -831,6 +831,11 @@ export interface PolygonExchange { url?: string } +/** + * Client for the Polygon.io REST API. + * + * @see {@link https://polygon.io/docs} + */ export class PolygonClient { /** * HTTP client for the Polygon API.