From e75c37b5e91bbc4ea527d6d0513856d54d426ed0 Mon Sep 17 00:00:00 2001 From: "ITRANSITION\\m.trifonov" Date: Fri, 6 Sep 2024 13:44:34 +0400 Subject: [PATCH 1/5] Added readme.md for Polygon connector --- .../Polygon/readme.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 independent-publisher-connectors/Polygon/readme.md diff --git a/independent-publisher-connectors/Polygon/readme.md b/independent-publisher-connectors/Polygon/readme.md new file mode 100644 index 0000000000..fee23c0812 --- /dev/null +++ b/independent-publisher-connectors/Polygon/readme.md @@ -0,0 +1,17 @@ +# Polygon +The Polygon.io Stocks API provides REST endpoints that let you query the latest market data from all US stock exchanges. + +## Publisher: Itransition Group + +## Prerequisites +You will need to register for an account with [Polygon](https://polygon.io/). + +## Obtaining Credentials +Once logged in to your account, you will find your API token in Dashboard. + +## Supported Operations +### Get stock price +Get the latest price of stock + +## Known Issues and Limitations +There are no known issues at this time. From ec5aa3f7d4f7a009c1eaaed186547805300d26b1 Mon Sep 17 00:00:00 2001 From: "ITRANSITION\\m.trifonov" Date: Thu, 12 Sep 2024 15:46:37 +0400 Subject: [PATCH 2/5] Created Polygon Connector --- .../Polygon/apiDefinition.swagger.json | 1219 +++++++++++++++++ .../Polygon/apiProperties.json | 23 + .../Polygon/readme.md | 26 +- 3 files changed, 1262 insertions(+), 6 deletions(-) create mode 100644 independent-publisher-connectors/Polygon/apiDefinition.swagger.json create mode 100644 independent-publisher-connectors/Polygon/apiProperties.json diff --git a/independent-publisher-connectors/Polygon/apiDefinition.swagger.json b/independent-publisher-connectors/Polygon/apiDefinition.swagger.json new file mode 100644 index 0000000000..c6bb9e7d6d --- /dev/null +++ b/independent-publisher-connectors/Polygon/apiDefinition.swagger.json @@ -0,0 +1,1219 @@ +{ + "swagger": "2.0", + "info": { + "title": "Polygon", + "description": "The Polygon.io Stocks API provides REST endpoints that let you query the latest market data from all US stock exchanges.", + "version": "1.0", + "contact": { + "name": "Itransition Group Ltd", + "url": "https://www.itransition.com/", + "email": "v.sumar@itransition.com" + } + }, + "host": "api.polygon.io", + "basePath": "/", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/v1/open-close/{stocksTicker}/{date}": { + "get": { + "summary": "Daily Open/Close", + "description": "Get the open, close and afterhours prices of a stock symbol on a certain date.", + "operationId": "GetDailyOpenClose", + "parameters": [ + { + "name": "stocksTicker", + "in": "path", + "required": true, + "type": "string", + "x-ms-summary": "Ticker", + "description": "Specify a case-sensitive ticker symbol." + }, + { + "name": "date", + "in": "path", + "required": true, + "type": "string", + "x-ms-summary": "Date", + "description": "The date of the requested open/close in the format YYYY-MM-DD." + }, + { + "name": "adjusted", + "in": "query", + "required": false, + "type": "boolean", + "x-ms-summary": "Adjusted", + "description": "Whether or not the results are adjusted for splits." + } + ], + "responses": { + "default": { + "description": "default", + "schema": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "status" + }, + "from": { + "type": "string", + "description": "from" + }, + "symbol": { + "type": "string", + "description": "symbol" + }, + "open": { + "type": "number", + "format": "float", + "description": "open" + }, + "high": { + "type": "number", + "format": "float", + "description": "high" + }, + "low": { + "type": "number", + "format": "float", + "description": "low" + }, + "close": { + "type": "number", + "format": "float", + "description": "close" + }, + "volume": { + "type": "integer", + "format": "int32", + "description": "volume" + }, + "afterHours": { + "type": "number", + "format": "float", + "description": "afterHours" + }, + "preMarket": { + "type": "number", + "format": "float", + "description": "preMarket" + } + } + } + } + } + } + }, + "/v3/reference/tickers": { + "get": { + "summary": "Tickers", + "description": "Query all ticker symbols.", + "operationId": "GetTickers", + "parameters": [ + { + "name": "ticker", + "in": "query", + "type": "string", + "x-ms-summary": "Ticker", + "description": "Specify a ticker symbol. Defaults to empty string which queries all tickers." + }, + { + "name": "type", + "in": "query", + "type": "string", + "x-ms-summary": "Type", + "description": "Specify the type of the tickers (e.g., stock, crypto).", + "enum": [ + "CS", + "ADRC", + "ADRP", + "ADRR", + "UNIT", + "RIGHT", + "PFD", + "FUND", + "SP", + "WARRANT", + "INDEX", + "ETF", + "ETN", + "OS", + "GDR", + "OTHER", + "NYRS", + "AGEN", + "EQLK", + "BOND", + "ADRW", + "BASKET", + "LT" + ] + }, + { + "name": "market", + "in": "query", + "type": "string", + "x-ms-summary": "Market", + "description": "Filter by market type. Defaults to all markets.", + "enum": [ + "stocks", + "crypto", + "fx", + "otc", + "indices" + ] + }, + { + "name": "exchange", + "in": "query", + "type": "string", + "x-ms-summary": "Exchange", + "description": "Specify the primary exchange of the asset in ISO code format." + }, + { + "name": "cusip", + "in": "query", + "type": "string", + "x-ms-summary": "CUSIP", + "description": "Specify the CUSIP code of the asset you want to search for." + }, + { + "name": "cik", + "in": "query", + "type": "string", + "x-ms-summary": "CIK", + "description": "Specify the CIK code of the asset you want to search for." + }, + { + "name": "date", + "in": "query", + "type": "string", + "x-ms-summary": "Date", + "description": "Specify a date to retrieve tickers (YYYY-MM-DD format)." + }, + { + "name": "search", + "in": "query", + "type": "string", + "x-ms-summary": "Search", + "description": "Search for terms within the ticker and/or company name." + }, + { + "name": "active", + "in": "query", + "type": "boolean", + "x-ms-summary": "Active", + "description": "Specify if the tickers returned should be actively traded on the queried date." + }, + { + "name": "order", + "in": "query", + "type": "string", + "x-ms-summary": "Order", + "description": "Order results based on the sort field.", + "enum": [ + "asc", + "desc" + ] + }, + { + "name": "sort", + "in": "query", + "type": "string", + "x-ms-summary": "Sort", + "description": "Sort field used for ordering.", + "enum": [ + "ticker", + "name", + "market", + "locale", + "primary_exchange", + "type", + "currency_symbol", + "currency_name", + "base_currency_symbol", + "base_currency_name", + "cik", + "composite_figi", + "share_class_figi", + "last_updated_utc", + "delisted_utc" + ] + }, + { + "name": "limit", + "in": "query", + "type": "integer", + "x-ms-summary": "Limit", + "description": "Limit the number of tickers returned in the result.." + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Status of the response" + }, + "count": { + "type": "integer", + "description": "Number of results", + "format": "int32" + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "active": { + "type": "boolean", + "description": "Whether the ticker is active" + }, + "cik": { + "type": "string", + "description": "The CIK (Central Index Key) of the asset" + }, + "composite_figi": { + "type": "string", + "description": "The composite FIGI of the asset" + }, + "currency_name": { + "type": "string", + "description": "The currency of the asset" + }, + "market": { + "type": "string", + "description": "The market type (e.g., stock, crypto)" + }, + "name": { + "type": "string", + "description": "The name of the asset" + }, + "primary_exchange": { + "type": "string", + "description": "The primary exchange of the asset" + }, + "ticker": { + "type": "string", + "description": "The ticker symbol" + }, + "type": { + "type": "string", + "description": "The type of the asset" + } + } + } + } + } + } + } + } + } + }, + "/v3/reference/tickers/{ticker}": { + "get": { + "summary": "Ticker Details", + "description": "Get a single ticker details.", + "operationId": "GetTickerDetails", + "parameters": [ + { + "name": "ticker", + "in": "path", + "description": "The ticker symbol of the asset.", + "required": true, + "x-ms-summary": "Ticker", + "type": "string" + }, + { + "name": "date", + "in": "query", + "description": "Specify a date to get information about the ticker.", + "required": false, + "x-ms-summary": "Date", + "type": "string", + "format": "date" + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "description": "The total number of results for this request." + }, + "request_id": { + "type": "string", + "description": "A request ID assigned by the server." + }, + "results": { + "type": "object", + "properties": { + "active": { + "type": "boolean", + "description": "Whether the ticker is active." + }, + "address": { + "type": "object", + "properties": { + "address1": { + "type": "string", + "description": "The company's address." + }, + "city": { + "type": "string" + }, + "postal_code": { + "type": "string" + }, + "state": { + "type": "string" + } + } + }, + "branding": { + "type": "object", + "properties": { + "icon_url": { + "type": "string" + }, + "logo_url": { + "type": "string" + } + } + }, + "cik": { + "type": "string", + "description": "The company's CIK (Central Index Key)." + }, + "composite_figi": { + "type": "string" + }, + "currency_name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "market_cap": { + "type": "number", + "description": "Market capitalization of the company." + }, + "market": { + "type": "string" + }, + "name": { + "type": "string" + }, + "primary_exchange": { + "type": "string" + }, + "ticker": { + "type": "string" + }, + "sic_code": { + "type": "string" + }, + "sic_description": { + "type": "string" + }, + "total_employees": { + "type": "integer", + "format": "int32" + }, + "type": { + "type": "string" + }, + "weighted_shares_outstanding": { + "type": "number", + "description": "The number of weighted shares outstanding." + } + } + } + } + } + } + } + } + }, + "/vX/reference/tickers/{id}/events": { + "get": { + "summary": "Ticker Events", + "description": "Get a timeline of events for the entity associated with the given ticker.", + "operationId": "GetTickerEvents", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier of an asset (Ticker, CUSIP, or Composite FIGI)", + "required": true, + "x-ms-summary": "Id", + "type": "string" + }, + { + "name": "types", + "in": "query", + "description": "A comma-separated list of the types of events to include.", + "required": false, + "x-ms-summary": "Types", + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "The status of the request" + }, + "request_id": { + "type": "string", + "description": "A unique request ID assigned by the server" + }, + "results": { + "type": "object", + "properties": { + "events": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "Date of the event" + }, + "ticker_change": { + "type": "object", + "properties": { + "ticker": { + "type": "string", + "description": "The new ticker after the change" + } + }, + "description": "Information about the ticker change event" + } + } + } + } + } + } + } + } + } + } + } + }, + "/v3/reference/splits": { + "get": { + "summary": "Stock Splits", + "description": "Get a list of historical stock splits.", + "operationId": "GetStockSplits", + "parameters": [ + { + "name": "ticker", + "in": "query", + "description": "The ticker symbol of the asset.", + "required": true, + "x-ms-summary": "Ticker", + "type": "string" + }, + { + "name": "execution_date", + "in": "query", + "description": "Query by execution date with the format YYYY-MM-DD.", + "required": false, + "x-ms-summary": "Execution date", + "type": "string" + }, + { + "name": "reverse_split", + "in": "query", + "description": "Query for reverse stock splits.", + "required": false, + "x-ms-summary": "Reverse split", + "type": "boolean" + }, + { + "name": "order", + "in": "query", + "description": "Order results based on the sort field.", + "required": false, + "x-ms-summary": "Order", + "type": "string", + "enum": [ + "asc", + "desc" + ] + }, + { + "name": "limit", + "in": "query", + "description": "Limit the number of results returned", + "required": false, + "x-ms-summary": "Limit", + "type": "integer", + "default": 10 + }, + { + "name": "sort", + "in": "query", + "description": "Sort field used for ordering.", + "required": false, + "x-ms-summary": "Sort", + "type": "string", + "enum": [ + "execution_date", + "ticker" + ] + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "type": "object", + "properties": { + "next_url": { + "type": "string", + "description": "URL for the next page of results" + }, + "results": { + "type": "array", + "description": "List of historical stock splits", + "items": { + "type": "object", + "properties": { + "execution_date": { + "type": "string", + "description": "Date of stock split execution" + }, + "id": { + "type": "string", + "description": "Unique identifier for the stock split record" + }, + "split_from": { + "type": "integer", + "description": "Split ratio from", + "title": "", + "format": "int32" + }, + "split_to": { + "type": "integer", + "description": "Split ratio to", + "title": "", + "format": "int32" + }, + "ticker": { + "type": "string", + "description": "Ticker symbol of the asset" + } + } + } + }, + "status": { + "type": "string", + "description": "Status of the API response." + } + } + } + } + } + } + }, + "/v3/reference/dividends": { + "get": { + "summary": "Dividends", + "description": "Get a list of historical cash dividends.", + "operationId": "GetStockDividends", + "parameters": [ + { + "name": "ticker", + "in": "query", + "description": "Specify a case-sensitive ticker symbol.", + "required": true, + "x-ms-summary": "Ticker", + "type": "string" + }, + { + "name": "ex_dividend_date", + "in": "query", + "description": "Query by ex-dividend date with the format YYYY-MM-DD.", + "required": false, + "x-ms-summary": "Ex dividend date", + "type": "string" + }, + { + "name": "record_date", + "in": "query", + "description": "Query by record date with the format YYYY-MM-DD.", + "required": false, + "x-ms-summary": "Record date", + "type": "string" + }, + { + "name": "declaration_date", + "in": "query", + "description": "Query by declaration date with the format YYYY-MM-DD.", + "required": false, + "x-ms-summary": "Declaration date", + "type": "string" + }, + { + "name": "pay_date", + "in": "query", + "description": "Query by pay date with the format YYYY-MM-DD.", + "required": false, + "x-ms-summary": "Pay Date", + "type": "string" + }, + { + "name": "frequency", + "in": "query", + "description": "Query by the number of times per year the dividend is paid out.", + "required": false, + "x-ms-summary": "Frequency", + "type": "integer", + "format": "int32", + "enum": [ + 0, + 1, + 2, + 4, + 12 + ] + }, + { + "name": "cash_amount", + "in": "query", + "description": "Query by the cash amount of the dividend.", + "required": false, + "x-ms-summary": "Cash amount", + "type": "number" + }, + { + "name": "dividend_type", + "in": "query", + "description": "Query by the type of dividend.", + "required": false, + "x-ms-summary": "Dividend Type", + "type": "string", + "enum": [ + "CD", + "SC", + "LT", + "ST" + ] + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "type": "object", + "properties": { + "next_url": { + "type": "string", + "description": "URL for the next page of results" + }, + "results": { + "type": "array", + "description": "List of historical dividends", + "items": { + "type": "object", + "properties": { + "cash_amount": { + "type": "number", + "description": "The cash amount of the dividend", + "title": "", + "format": "float" + }, + "declaration_date": { + "type": "string", + "description": "The date when the dividend was declared" + }, + "ex_dividend_date": { + "type": "string", + "description": "The date when the stock starts trading without the value of the dividend" + }, + "frequency": { + "type": "integer", + "description": "The frequency of the dividend payments", + "title": "", + "format": "int32" + }, + "id": { + "type": "string", + "description": "Unique identifier for the dividend record" + }, + "pay_date": { + "type": "string", + "description": "The date when the dividend is paid to shareholders" + }, + "record_date": { + "type": "string", + "description": "The date when the shareholder must own the stock to receive the dividend" + }, + "ticker": { + "type": "string", + "description": "Ticker symbol of the stock" + } + } + } + }, + "status": { + "type": "string", + "description": "Status of the API response." + } + } + } + } + } + } + }, + "/vX/reference/financials": { + "get": { + "summary": "Stock Financials", + "description": "Returns financial data for a given ticker or company based on various filters.", + "parameters": [ + { + "name": "ticker", + "in": "query", + "description": "The ticker symbol to filter financial data.", + "required": false, + "x-ms-summary": "Ticker", + "type": "string" + }, + { + "name": "cik", + "in": "query", + "description": "The central index key (CIK) number to filter financial data.", + "required": false, + "x-ms-summary": "Cic", + "type": "string" + }, + { + "name": "company_name", + "in": "query", + "description": "The company name to filter financial data.", + "x-ms-summary": "Company name", + "required": false, + "type": "string" + }, + { + "name": "sic", + "in": "query", + "description": "Standard industrial classification to filter financial data.", + "required": false, + "x-ms-summary": "Sic", + "type": "string" + }, + { + "name": "filing_date", + "in": "query", + "description": "Filter financial data by the filing date (YYYY-MM-DD).", + "required": false, + "x-ms-summary": "Filing Date", + "type": "string" + }, + { + "name": "period_of_report_date", + "in": "query", + "description": "The period of report for the filing with financial data (YYYY-MM-DD).", + "x-ms-summary": "Period of report date", + "required": false, + "type": "string" + }, + { + "name": "timeframe", + "in": "query", + "description": "Filter by timeframe (e.g., annual or quarterly).", + "required": false, + "type": "string", + "x-ms-summary": "Timeframe", + "enum": [ + "annual", + "quarterly", + "ttm" + ] + }, + { + "name": "include_sources", + "in": "query", + "description": "Whether to include `xpath` and `formula` attributes for financial data points.", + "required": false, + "type": "boolean", + "x-ms-summary": "Indlude sources" + }, + { + "name": "order", + "in": "query", + "description": "Order results based on the sort field.", + "required": false, + "type": "string", + "x-ms-summary": "Order", + "enum": [ + "asc", + "desc" + ] + }, + { + "name": "limit", + "in": "query", + "description": "Limit the number of results. Default is 10, max is 100.", + "required": false, + "type": "integer" + }, + { + "name": "sort", + "in": "query", + "description": "Sort field for ordering.", + "required": false, + "type": "string", + "x-ms-summary": "Sort", + "enum": [ + "filing_date", + "period_of_report_date" + ] + } + ], + "responses": { + "200": { + "description": "A list of financial data for the given ticker or company.", + "schema": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "description": "The total number of results.", + "title": "", + "format": "int32" + }, + "next_url": { + "type": "string", + "description": "URL for the next page of results." + }, + "request_id": { + "type": "string", + "description": "A request ID assigned by the server." + }, + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "cik": { + "type": "string", + "description": "Central Index Key (CIK)." + }, + "company_name": { + "type": "string", + "description": "Company name." + }, + "end_date": { + "type": "string", + "description": "End date of the financial report." + }, + "filing_date": { + "type": "string", + "description": "Date when the filing was submitted." + }, + "fiscal_period": { + "type": "string", + "description": "Fiscal period (e.g., Q1)." + }, + "fiscal_year": { + "type": "string", + "description": "Fiscal year." + }, + "start_date": { + "type": "string", + "description": "Start date of the financial report." + }, + "source_filing_file_url": { + "type": "string", + "description": "URL for the source filing file." + }, + "financials": { + "type": "object", + "properties": { + "balance_sheet": { + "type": "object", + "properties": { + "assets": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "unit": { + "type": "string" + }, + "value": { + "type": "integer", + "title": "", + "format": "int32" + } + } + }, + "liabilities": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "unit": { + "type": "string" + }, + "value": { + "type": "integer", + "title": "", + "format": "int32" + } + } + }, + "equity": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "unit": { + "type": "string" + }, + "value": { + "type": "integer", + "title": "", + "format": "int32" + } + } + } + } + }, + "income_statement": { + "type": "object", + "properties": { + "revenue": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "unit": { + "type": "string" + }, + "value": { + "type": "integer", + "title": "", + "format": "int32" + } + } + }, + "net_income": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "unit": { + "type": "string" + }, + "value": { + "type": "integer", + "title": "", + "format": "int32" + } + } + } + } + }, + "cash_flow_statement": { + "type": "object", + "properties": { + "net_cash_flow": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "unit": { + "type": "string" + }, + "value": { + "type": "integer", + "title": "", + "format": "int32" + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "operationId": "GetStockFinancialDetails" + } + }, + "/v3/reference/exchanges": { + "get": { + "summary": "Exchanges", + "description": "Get a list of exchanges including stocks, options, crypto, and more.", + "operationId": "GetExchanges", + "parameters": [ + { + "name": "asset_class", + "in": "query", + "type": "string", + "description": "Filter by asset class, e.g., stocks, options, crypto, fx", + "x-ms-summary": "Asset class", + "required": false, + "enum": [ + "stocks", + "options", + "crypto", + "fx" + ] + }, + { + "name": "locale", + "in": "query", + "type": "string", + "description": "Filter by locale", + "x-ms-summary": "Locale", + "required": false, + "enum": [ + "us", + "global" + ] + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "description": "The total number of results for this request.", + "title": "", + "format": "int32" + }, + "request_id": { + "type": "string", + "description": "A request id assigned by the server." + }, + "results": { + "type": "array", + "description": "List of exchange data", + "items": { + "type": "object", + "properties": { + "acronym": { + "type": "string", + "description": "The acronym of the exchange" + }, + "asset_class": { + "type": "string", + "description": "The asset class the exchange supports (e.g., stocks)" + }, + "id": { + "type": "integer", + "description": "The exchange id", + "title": "", + "format": "int32" + }, + "locale": { + "type": "string", + "description": "The locale (country/region) of the exchange" + }, + "mic": { + "type": "string", + "description": "The MIC (Market Identifier Code) of the exchange" + }, + "name": { + "type": "string", + "description": "The full name of the exchange" + }, + "operating_mic": { + "type": "string", + "description": "The operating MIC of the exchange" + }, + "participant_id": { + "type": "string", + "description": "The participant id of the exchange" + }, + "type": { + "type": "string", + "description": "The type of the exchange" + }, + "url": { + "type": "string", + "description": "The URL of the exchange's website" + } + } + } + }, + "status": { + "type": "string", + "description": "The status of the request" + } + } + } + } + } + } + } + }, + "definitions": {}, + "parameters": {}, + "responses": {}, + "securityDefinitions": { + "apiKey": { + "type": "apiKey", + "in": "query", + "name": "apiKey" + } + }, + "security": [ + { + "apiKey": [] + } + ], + "tags": [], + "x-ms-connector-metadata": [ + { + "propertyName": "Website", + "propertyValue": "https://polygon.io/" + }, + { + "propertyName": "Privacy policy", + "propertyValue": "https://polygon.io/privacy" + }, + { + "propertyName": "Categories", + "propertyValue": "Data;Financials" + } + ] + } \ No newline at end of file diff --git a/independent-publisher-connectors/Polygon/apiProperties.json b/independent-publisher-connectors/Polygon/apiProperties.json new file mode 100644 index 0000000000..08de984f2c --- /dev/null +++ b/independent-publisher-connectors/Polygon/apiProperties.json @@ -0,0 +1,23 @@ +{ + "properties": { + "connectionParameters": { + "api_key": { + "type": "securestring", + "uiDefinition": { + "displayName": "apiKey", + "description": "The apiKey for this api", + "tooltip": "Provide your apiKey", + "constraints": { + "tabIndex": 2, + "clearText": false, + "required": "true" + } + } + } + }, + "iconBrandColor": "#da3b01", + "capabilities": [], + "publisher": "Itransition Group Ltd", + "stackOwner": "Polygon.io" + } +} \ No newline at end of file diff --git a/independent-publisher-connectors/Polygon/readme.md b/independent-publisher-connectors/Polygon/readme.md index fee23c0812..9d249cfaa1 100644 --- a/independent-publisher-connectors/Polygon/readme.md +++ b/independent-publisher-connectors/Polygon/readme.md @@ -1,17 +1,31 @@ # Polygon -The Polygon.io Stocks API provides REST endpoints that let you query the latest market data from all US stock exchanges. +The Polygon.io Stocks API provides comprehensive REST endpoints that enable querying of real-time and historical market data across all US stock exchanges. With extensive coverage, the API includes stock quotes, tickers, splits, dividends, and financial data, making it a powerful tool for developers working with financial information. -## Publisher: Itransition Group +## Publisher: Itransition Group Ltd ## Prerequisites -You will need to register for an account with [Polygon](https://polygon.io/). +To use the Polygon API, you will need to register for an account with [Polygon](https://polygon.io/). Once registered, you'll have access to your API credentials and can begin making requests to the service. ## Obtaining Credentials -Once logged in to your account, you will find your API token in Dashboard. +After logging into your Polygon.io account, you can retrieve your API token from your [Dashboard](https://polygon.io/dashboard). This token is required to authenticate and authorize your API requests. ## Supported Operations -### Get stock price -Get the latest price of stock +### Daily Open/Close +Retrieve the open, close, and afterhours prices of a stock symbol on a specific date. +### Tickers +Query all supported ticker symbols, including Stocks/Equities, Indices, Forex, and Crypto. +### Ticker Details +Fetch detailed information about a specific ticker, including company background data. +### Ticker Events +Retrieve a timeline of events for an entity associated with a given ticker, CUSIP, or Composite FIGI. +### Stock Splits +Get a comprehensive list of historical stock splits, including details such as the ticker symbol, execution date, and split ratios. +### Dividends +Get a historical record of cash dividends, including the declaration date, ex-dividend date, record date, pay date, frequency, and amount. +### Stock Financials +Query detailed financial data for a specific ticker or company using filters like filing date, timeframe, and more. +### Exchanges +List all available exchanges that Polygon.io supports, including those for stocks, options, crypto, and more. ## Known Issues and Limitations There are no known issues at this time. From 2413fc72d9626e323245a791b32cf4baae52b3db Mon Sep 17 00:00:00 2001 From: "ITRANSITION\\m.trifonov" Date: Thu, 12 Sep 2024 17:41:04 +0400 Subject: [PATCH 3/5] Fix response types --- .../Polygon/apiDefinition.swagger.json | 33 ++++++++++--------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/independent-publisher-connectors/Polygon/apiDefinition.swagger.json b/independent-publisher-connectors/Polygon/apiDefinition.swagger.json index c6bb9e7d6d..cdea1a9eaf 100644 --- a/independent-publisher-connectors/Polygon/apiDefinition.swagger.json +++ b/independent-publisher-connectors/Polygon/apiDefinition.swagger.json @@ -24,7 +24,7 @@ "paths": { "/v1/open-close/{stocksTicker}/{date}": { "get": { - "summary": "Daily Open/Close", + "summary": "Daily Open Close", "description": "Get the open, close and afterhours prices of a stock symbol on a certain date.", "operationId": "GetDailyOpenClose", "parameters": [ @@ -92,9 +92,10 @@ "description": "close" }, "volume": { - "type": "integer", - "format": "int32", - "description": "volume" + "type": "number", + "format": "float", + "description": "volume", + "title": "" }, "afterHours": { "type": "number", @@ -965,9 +966,9 @@ "type": "string" }, "value": { - "type": "integer", + "type": "number", "title": "", - "format": "int32" + "format": "float" } } }, @@ -981,9 +982,9 @@ "type": "string" }, "value": { - "type": "integer", + "type": "number", "title": "", - "format": "int32" + "format": "float" } } }, @@ -997,9 +998,9 @@ "type": "string" }, "value": { - "type": "integer", + "type": "number", "title": "", - "format": "int32" + "format": "double" } } } @@ -1018,9 +1019,9 @@ "type": "string" }, "value": { - "type": "integer", + "type": "number", "title": "", - "format": "int32" + "format": "float" } } }, @@ -1034,9 +1035,9 @@ "type": "string" }, "value": { - "type": "integer", + "type": "number", "title": "", - "format": "int32" + "format": "float" } } } @@ -1055,9 +1056,9 @@ "type": "string" }, "value": { - "type": "integer", + "type": "number", "title": "", - "format": "int32" + "format": "float" } } } From 328cb6f5f0d0b14b871ccc8bf21e793069ebcf14 Mon Sep 17 00:00:00 2001 From: "ITRANSITION\\m.trifonov" Date: Thu, 12 Sep 2024 17:45:55 +0400 Subject: [PATCH 4/5] Remove empty properties --- .../Polygon/apiDefinition.swagger.json | 16 +--------------- 1 file changed, 1 insertion(+), 15 deletions(-) diff --git a/independent-publisher-connectors/Polygon/apiDefinition.swagger.json b/independent-publisher-connectors/Polygon/apiDefinition.swagger.json index cdea1a9eaf..182eb5ace8 100644 --- a/independent-publisher-connectors/Polygon/apiDefinition.swagger.json +++ b/independent-publisher-connectors/Polygon/apiDefinition.swagger.json @@ -94,8 +94,7 @@ "volume": { "type": "number", "format": "float", - "description": "volume", - "title": "" + "description": "volume" }, "afterHours": { "type": "number", @@ -611,13 +610,11 @@ "split_from": { "type": "integer", "description": "Split ratio from", - "title": "", "format": "int32" }, "split_to": { "type": "integer", "description": "Split ratio to", - "title": "", "format": "int32" }, "ticker": { @@ -741,7 +738,6 @@ "cash_amount": { "type": "number", "description": "The cash amount of the dividend", - "title": "", "format": "float" }, "declaration_date": { @@ -755,7 +751,6 @@ "frequency": { "type": "integer", "description": "The frequency of the dividend payments", - "title": "", "format": "int32" }, "id": { @@ -902,7 +897,6 @@ "count": { "type": "integer", "description": "The total number of results.", - "title": "", "format": "int32" }, "next_url": { @@ -967,7 +961,6 @@ }, "value": { "type": "number", - "title": "", "format": "float" } } @@ -983,7 +976,6 @@ }, "value": { "type": "number", - "title": "", "format": "float" } } @@ -999,7 +991,6 @@ }, "value": { "type": "number", - "title": "", "format": "double" } } @@ -1020,7 +1011,6 @@ }, "value": { "type": "number", - "title": "", "format": "float" } } @@ -1036,7 +1026,6 @@ }, "value": { "type": "number", - "title": "", "format": "float" } } @@ -1057,7 +1046,6 @@ }, "value": { "type": "number", - "title": "", "format": "float" } } @@ -1118,7 +1106,6 @@ "count": { "type": "integer", "description": "The total number of results for this request.", - "title": "", "format": "int32" }, "request_id": { @@ -1142,7 +1129,6 @@ "id": { "type": "integer", "description": "The exchange id", - "title": "", "format": "int32" }, "locale": { From 61a5f9acf73e5ac18581f9f99bbd1919447ab56b Mon Sep 17 00:00:00 2001 From: "ITRANSITION\\m.trifonov" Date: Fri, 13 Sep 2024 10:34:28 +0400 Subject: [PATCH 5/5] fix swagger --- .../Polygon/apiDefinition.swagger.json | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/independent-publisher-connectors/Polygon/apiDefinition.swagger.json b/independent-publisher-connectors/Polygon/apiDefinition.swagger.json index 182eb5ace8..cf30aceb69 100644 --- a/independent-publisher-connectors/Polygon/apiDefinition.swagger.json +++ b/independent-publisher-connectors/Polygon/apiDefinition.swagger.json @@ -34,6 +34,7 @@ "required": true, "type": "string", "x-ms-summary": "Ticker", + "x-ms-url-encoding": "single", "description": "Specify a case-sensitive ticker symbol." }, { @@ -42,6 +43,7 @@ "required": true, "type": "string", "x-ms-summary": "Date", + "x-ms-url-encoding": "single", "description": "The date of the requested open/close in the format YYYY-MM-DD." }, { @@ -54,8 +56,8 @@ } ], "responses": { - "default": { - "description": "default", + "200": { + "description": "Successful operation", "schema": { "type": "object", "properties": { @@ -333,6 +335,7 @@ "description": "The ticker symbol of the asset.", "required": true, "x-ms-summary": "Ticker", + "x-ms-url-encoding": "single", "type": "string" }, { @@ -461,6 +464,7 @@ "description": "Identifier of an asset (Ticker, CUSIP, or Composite FIGI)", "required": true, "x-ms-summary": "Id", + "x-ms-url-encoding": "single", "type": "string" }, { @@ -873,7 +877,8 @@ "in": "query", "description": "Limit the number of results. Default is 10, max is 100.", "required": false, - "type": "integer" + "type": "integer", + "x-ms-summary": "Limit" }, { "name": "sort", @@ -1200,7 +1205,7 @@ }, { "propertyName": "Categories", - "propertyValue": "Data;Financials" + "propertyValue": "Data;Finance" } ] } \ No newline at end of file