update for new summaries endpoint (#113)

* added the stocks summary endpoint to the client libary:

* feat: added summaries to each asset type and asset client

Author: mpatel18

src/rest/crypto/index.ts

@@ -30,6 +30,8 @@ import {
   snapshotTicker,
   snapshotTickerFullBookL2,
 } from "./snapshots";
+import { ISummaries, ISummariesQuery } from "../stocks/summaries";
+import { summaries } from "./summaries";
 
 export {
   ICryptoDailyOpenCloseQuery,
@@ -57,6 +59,7 @@ export interface ICryptoClient {
     date: string,
     query?: IAggsGroupedDailyQuery
   ) => Promise<IAggsGroupedDaily>;
+  summaries: (query?: ISummariesQuery) => Promise<ISummaries>;
   dailyOpenClose: (
     from: string,
     to: string,
@@ -90,6 +93,7 @@ export const cryptoClient = (
 ): ICryptoClient => ({
   aggregates: auth(apiKey, aggregates, apiBase),
   aggregatesGroupedDaily: auth(apiKey, aggregatesGroupedDaily, apiBase),
+  summaries: auth(apiKey, summaries, apiBase),
   dailyOpenClose: auth(apiKey, dailyOpenClose, apiBase),
   lastTrade: auth(apiKey, lastTrade, apiBase),
   trades: auth(apiKey, trades, apiBase),

src/rest/crypto/summaries.ts

@@ -0,0 +1,16 @@
+// CF: 
+
+import { get } from "../transport/request";
+import { ISummaries, ISummariesQuery } from "../stocks/summaries";
+
+export const summaries = async (
+  apikey: string,
+  apiBase: string,
+  query?: ISummariesQuery
+): Promise<ISummaries> =>
+  get(
+    `/v1/summaries`,
+    apikey,
+    apiBase,
+    query
+  );

src/rest/forex/index.ts

@@ -24,6 +24,8 @@ import {
   snapshotGainersLosers,
   snapshotTicker,
 } from "./snapshots";
+import { ISummaries, ISummariesQuery } from "../stocks/summaries";
+import { summaries } from "./summaries";
 
 export { IConversionQuery, IConversion } from "./conversion";
 export { IForexQuotes } from "./quotes";
@@ -51,6 +53,7 @@ export interface IForexClient {
     date: string,
     query?: IAggsGroupedDailyQuery
   ) => Promise<IAggsGroupedDaily>;
+  summaries: (query?: ISummariesQuery) => Promise<ISummaries>;
   conversion: (
     from: string,
     to: string,
@@ -80,6 +83,7 @@ export const forexClient = (
 ): IForexClient => ({
   aggregates: auth(apiKey, aggregates, apiBase),
   aggregatesGroupedDaily: auth(apiKey, aggregatesGroupedDaily, apiBase),
+  summaries: auth(apiKey, summaries, apiBase),
   conversion: auth(apiKey, conversion, apiBase),
   quotes: auth(apiKey, quotes, apiBase),
   lastQuote: auth(apiKey, lastQuote, apiBase),

src/rest/forex/summaries.ts

@@ -0,0 +1,16 @@
+// CF: 
+
+import { get } from "../transport/request";
+import { ISummaries, ISummariesQuery } from "../stocks/summaries";
+
+export const summaries = async (
+  apikey: string,
+  apiBase: string,
+  query?: ISummariesQuery
+): Promise<ISummaries> =>
+  get(
+    `/v1/summaries`,
+    apikey,
+    apiBase,
+    query
+  );

src/rest/options/index.ts

@@ -17,6 +17,8 @@ import { IOptionTrades, trades } from "./trades";
 import { IOptionsLastTrade, lastTrade } from "./lastTrade";
 import { IOptionQuotes, quotes } from "./quotes";
 import { IOptionsSnapshotContract, snapshotOptionContract } from "./snapshots";
+import { ISummaries, ISummariesQuery } from "../stocks/summaries";
+import { summaries } from "./summaries";
 
 export {
   IOptionsDailyOpenCloseQuery,
@@ -36,6 +38,7 @@ export interface IOptionsClient {
     to: string,
     query?: IAggsQuery
   ) => Promise<IAggs>;
+  summaries: (query?: ISummariesQuery) => Promise<ISummaries>;
   dailyOpenClose: (
     symbol: string,
     date: string,
@@ -65,6 +68,7 @@ export const optionsClient = (
   apiBase = "https://api.polygon.io"
 ): IOptionsClient => ({
   aggregates: auth(apiKey, aggregates, apiBase),
+  summaries: auth(apiKey, summaries, apiBase),
   dailyOpenClose: auth(apiKey, dailyOpenClose, apiBase),
   previousClose: auth(apiKey, previousClose, apiBase),
   trades: auth(apiKey, trades, apiBase),

src/rest/options/summaries.ts

@@ -0,0 +1,16 @@
+// CF: 
+
+import { get } from "../transport/request";
+import { ISummaries, ISummariesQuery } from "../stocks/summaries";
+
+export const summaries = async (
+  apikey: string,
+  apiBase: string,
+  query?: ISummariesQuery
+): Promise<ISummaries> =>
+  get(
+    `/v1/summaries`,
+    apikey,
+    apiBase,
+    query
+  );

src/rest/stocks/index.ts

@@ -28,6 +28,7 @@ import {
 } from "./snapshots";
 import { IQuotes, quotes } from "./quotes";
 import { ITradesQuotesQuery, ITrades, trades } from "./trades";
+import { ISummaries, ISummariesQuery, summaries } from "./summaries";
 
 export { IAggsQuery, IAggs } from "./aggregates";
 export {
@@ -59,6 +60,7 @@ export interface IStocksClient {
     date: string,
     query?: IAggsGroupedDailyQuery
   ) => Promise<IAggsGroupedDaily>;
+  summaries: (query?: ISummariesQuery) => Promise<ISummaries>;
   dailyOpenClose: (
     symbol: string,
     date: string,
@@ -87,6 +89,7 @@ export const stocksClient = (
 ): IStocksClient => ({
   aggregates: auth(apiKey, aggregates, apiBase),
   aggregatesGroupedDaily: auth(apiKey, aggregatesGroupedDaily, apiBase),
+  summaries: auth(apiKey, summaries, apiBase),
   dailyOpenClose: auth(apiKey, dailyOpenClose, apiBase),
   lastQuote: auth(apiKey, lastQuote, apiBase),
   lastTrade: auth(apiKey, lastTrade, apiBase),

src/rest/stocks/summaries.ts

@@ -0,0 +1,66 @@
+// CF: 
+
+import { get, IPolygonQuery } from "../transport/request";
+
+export interface IBranding {
+    icon_url: string;
+    logo_url: string;
+}
+
+export interface IOptions {
+    contract_type: 'put' | 'call' | 'other';
+    exercise_style: 'american' | 'european' | 'bermudan';
+    expiration_date: string;
+    shares_per_contract: number;
+    strike_price: number;
+    underlying_ticker: string;
+}
+
+export interface ISession {
+    change: number;
+    change_percent: number;
+    close: number;
+    early_trading_change: number;
+    early_trading_change_percent: number;
+    high: number;
+    late_trading_change: number;
+    late_trading_change_percent: number;
+    low: number;
+    open: number;
+    pervious_close: number;
+    volume: number;
+
+}
+
+export interface ISummariesResults {
+  branding: IBranding;
+  market_status: string;
+  name: string;
+  option: IOptions;
+  price: number;
+  session: ISession;
+  ticker: string;
+  type: 'stock' | 'option' | 'forex' | 'crypto';
+}
+
+export interface ISummariesQuery extends IPolygonQuery {
+  'ticker.any_of'?: string;
+}
+
+export interface ISummaries {
+  request_id?: string;
+  status?: string;
+  results?: ISummariesResults[];
+}
+
+export const summaries = async (
+  apikey: string,
+  apiBase: string,
+  query?: ISummariesQuery
+): Promise<ISummaries> =>
+  get(
+    `/v1/summaries`,
+    apikey,
+    apiBase,
+    query
+  );