feat: add polygon.io service

PR-URL: #27

docs/polygon.md

@@ -0,0 +1,23 @@
+<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 "Copy" button.
+
+   ![](https://ajeuwbhvhr.cloudimg.io/colony-recorder.s3.amazonaws.com/files/2023-06-24/6c09ebfa-b326-4446-b8e8-89bf01b2bff3/user_cropped_screenshot.jpeg?tl_px=25,0&br_px=1145,630&force_format=png&width=560&wat_scale=50&wat=1&wat_opacity=0.7&wat_gravity=northwest&wat_url=https://colony-recorder.s3.us-west-1.amazonaws.com/images/watermarks/FB923C_standard.png&wat_pad=479,111)
+
+[polygon]: https://polygon.io

src/services/index.ts

@@ -2,6 +2,7 @@ export * from './bing-web-search'
 export * from './diffbot'
 export * from './metaphor'
 export * from './novu'
+export * from './polygon'
 export * from './serpapi'
 export * from './slack'
 export * from './twilio-conversation'

test/services/polygon.test.ts

@@ -0,0 +1,236 @@
+import test from 'ava'
+
+import { PolygonClient } from '@/services/polygon'
+
+import { ky } from '../_utils'
+
+test('PolygonClient.aggregates', async (t) => {
+  if (!process.env.POLYGON_API_KEY) {
+    return t.pass()
+  }
+
+  t.timeout(2 * 60 * 1000)
+  const client = new PolygonClient({ ky })
+
+  const result = await client.aggregates({
+    ticker: 'AAPL',
+    from: '2023-01-01',
+    to: '2023-01-03',
+    multiplier: 1,
+    timespan: 'day',
+    limit: 1
+  })
+  t.is(typeof result.status, 'string', 'Status should be a string')
+  t.is(typeof result.request_id, 'string', 'Request_id should be a string')
+  t.is(typeof result.queryCount, 'number', 'queryCount should be a number')
+  t.is(typeof result.resultsCount, 'number', 'resultsCount should be a number')
+  t.is(typeof result.adjusted, 'boolean', 'adjusted should be a boolean')
+  t.is(typeof result.results, 'object', 'results should be an object')
+})
+
+test('PolygonClient.dailyOpenClose', async (t) => {
+  if (!process.env.POLYGON_API_KEY) {
+    return t.pass()
+  }
+
+  t.timeout(2 * 60 * 1000)
+  const client = new PolygonClient({ ky })
+
+  const result = await client.dailyOpenClose({
+    ticker: 'AAPL',
+    date: '2023-06-21'
+  })
+  t.truthy(result.from)
+  t.is(result.symbol, 'AAPL')
+})
+
+test('PolygonClient.ema', async (t) => {
+  if (!process.env.POLYGON_API_KEY) {
+    return t.pass()
+  }
+
+  t.timeout(2 * 60 * 1000)
+  const client = new PolygonClient({ ky })
+
+  const result = await client.ema({ ticker: 'AAPL' })
+  t.truthy(result.results)
+  t.true(Array.isArray(result.results.values))
+})
+
+test('PolygonClient.exchanges', async (t) => {
+  if (!process.env.POLYGON_API_KEY) {
+    return t.pass()
+  }
+
+  t.timeout(2 * 60 * 1000)
+  const client = new PolygonClient({ ky })
+
+  const result = await client.exchanges({
+    asset_class: 'stocks'
+  })
+  t.truthy(result.status)
+  t.true(Array.isArray(result.results))
+})
+
+test('PolygonClient.groupedDaily', async (t) => {
+  if (!process.env.POLYGON_API_KEY) {
+    return t.pass()
+  }
+
+  t.timeout(2 * 60 * 1000)
+  const client = new PolygonClient({ ky })
+
+  const result = await client.groupedDaily('stocks', { date: '2023-06-21' })
+  t.truthy(result.status)
+  t.true(Array.isArray(result.results))
+})
+
+test('PolygonClient.macd', async (t) => {
+  if (!process.env.POLYGON_API_KEY) {
+    return t.pass()
+  }
+
+  t.timeout(2 * 60 * 1000)
+  const client = new PolygonClient({ ky })
+
+  const result = await client.macd({ ticker: 'AAPL' })
+  t.truthy(result.results)
+  t.true(Array.isArray(result.results.values))
+})
+
+test('PolygonClient.marketHolidays', async (t) => {
+  if (!process.env.POLYGON_API_KEY) {
+    return t.pass()
+  }
+
+  t.timeout(2 * 60 * 1000)
+  const client = new PolygonClient({ ky })
+
+  const result = await client.marketHolidays()
+  t.true(Array.isArray(result), 'Result should be an array')
+})
+
+test('PolygonClient.marketStatus', async (t) => {
+  if (!process.env.POLYGON_API_KEY) {
+    return t.pass()
+  }
+
+  t.timeout(2 * 60 * 1000)
+  const client = new PolygonClient({ ky })
+
+  const result = await client.marketStatus()
+
+  t.true(typeof result.afterHours === 'boolean')
+  t.truthy(result.currencies)
+  t.true(typeof result.currencies.crypto === 'string')
+  t.true(typeof result.currencies.fx === 'string')
+  t.true(typeof result.earlyHours === 'boolean')
+  t.truthy(result.exchanges)
+  t.true(typeof result.exchanges.nasdaq === 'string')
+  t.true(typeof result.exchanges.nyse === 'string')
+  t.true(typeof result.exchanges.otc === 'string')
+  t.true(typeof result.market === 'string')
+  t.true(typeof result.serverTime === 'string')
+})
+
+test('PolygonClient.previousClose', async (t) => {
+  if (!process.env.POLYGON_API_KEY) {
+    return t.pass()
+  }
+
+  t.timeout(2 * 60 * 1000)
+  const client = new PolygonClient({ ky })
+
+  const result = await client.previousClose('AAPL')
+  t.truthy(result.ticker)
+  t.is(result.ticker, 'AAPL')
+})
+
+test('PolygonClient.rsi', async (t) => {
+  if (!process.env.POLYGON_API_KEY) {
+    return t.pass()
+  }
+
+  t.timeout(2 * 60 * 1000)
+  const client = new PolygonClient({ ky })
+
+  const result = await client.rsi({ ticker: 'AAPL' })
+  t.truthy(result.results)
+  t.true(Array.isArray(result.results.values))
+})
+
+test('PolygonClient.sma', async (t) => {
+  if (!process.env.POLYGON_API_KEY) {
+    return t.pass()
+  }
+
+  t.timeout(2 * 60 * 1000)
+  const client = new PolygonClient({ ky })
+
+  const result = await client.sma({ ticker: 'AAPL' })
+  t.truthy(result.results)
+  t.true(Array.isArray(result.results.values))
+})
+
+test('PolygonClient.tickerDetails', async (t) => {
+  if (!process.env.POLYGON_API_KEY) {
+    return t.pass()
+  }
+
+  t.timeout(2 * 60 * 1000)
+  const client = new PolygonClient({ ky })
+
+  const result = await client.tickerDetails({ ticker: 'AAPL' })
+  t.truthy(result.results)
+  t.is(result.results.ticker, 'AAPL')
+})
+
+test('PolygonClient.tickerNews', async (t) => {
+  if (!process.env.POLYGON_API_KEY) {
+    return t.pass()
+  }
+
+  t.timeout(2 * 60 * 1000)
+  const client = new PolygonClient({ ky })
+
+  let result = await client.tickerNews({ ticker: 'AAPL', limit: 3 })
+  t.truthy(result.status)
+  t.true(Array.isArray(result.results))
+  t.is(result.results.length, 3)
+
+  result = await client.tickerNews({ ticker: 'NFLX', limit: 1 })
+  t.truthy(result.status)
+  t.true(Array.isArray(result.results))
+  t.is(result.results.length, 1)
+})
+
+test('PolygonClient.tickerTypes', async (t) => {
+  if (!process.env.POLYGON_API_KEY) {
+    return t.pass()
+  }
+
+  t.timeout(2 * 60 * 1000)
+  const client = new PolygonClient({ ky })
+
+  const result = await client.tickerTypes()
+  t.is(typeof result.status, 'string', 'Status should be a string')
+  t.is(typeof result.request_id, 'string', 'Request_id should be a string')
+  t.is(typeof result.count, 'number', 'Count should be a number')
+})
+
+test('PolygonClient.tickers', async (t) => {
+  if (!process.env.POLYGON_API_KEY) {
+    return t.pass()
+  }
+
+  t.timeout(2 * 60 * 1000)
+  const client = new PolygonClient({ ky })
+
+  const result = await client.tickers({
+    ticker: 'AAPL',
+    limit: 1
+  })
+  t.is(typeof result.status, 'string', 'Status should be a string')
+  t.is(typeof result.request_id, 'string', 'Request_id should be a string')
+  t.is(typeof result.count, 'number', 'Count should be a number')
+})