docs: add service readme file

old-agentic-v1^2
Philipp Burckhardt 2023-06-24 11:10:25 -04:00
rodzic 016bdff1a6
commit 42ff3f96a3
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: A2C3BCA4F31D1DDD
2 zmienionych plików z 26 dodań i 0 usunięć

21
docs/polygon.md 100644
Wyświetl plik

@ -0,0 +1,21 @@
<h1 align="center">Polygon.io Agentic Service</h1>
## 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

Wyświetl plik

@ -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.