1421ba72aa
* Weather API CDK Added * Polygon-Stocks-API CDK Added Polygon-Stocks-API is the API provided by https://polygon.io/ to get details about the stock * spec.yaml updated * Files Changes Resolved * Review Changes Are Performed * Some Requested Changes Are Done Add title to your parameters is done Change from to start_date and to to end_date is done * correct schema * add polygon to source def * run format * correct primary key * auto-bump connector version Co-authored-by: Harshil Khamar <harshilkhamar1@gmail.com> Co-authored-by: Harshil Khamar <73790584+Harshil0512@users.noreply.github.com> Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
57 lines
2.8 KiB
Markdown
57 lines
2.8 KiB
Markdown
# Polygon Stock API
|
|
|
|
## Sync overview
|
|
|
|
This source can give information about stocks data available on
|
|
[PolygonStocksApi](https://polygon.io). It currently only supports Full Refresh
|
|
syncs.
|
|
|
|
### Output schema
|
|
|
|
This source is capable of syncing the following streams:
|
|
|
|
* `stock_api`
|
|
|
|
### Features
|
|
|
|
| Feature | Supported? \(Yes/No\) | Notes |
|
|
|:------------------|:----------------------|:--------------------------------------------------------|
|
|
| Full Refresh Sync | Yes | |
|
|
| Incremental Sync | No | |
|
|
|
|
### Performance considerations
|
|
|
|
Polygon Stocks API allows only 5 API Calls/Minute on the free plan. Use of this connector
|
|
may require a paid plan based upon your requirements.
|
|
|
|
## Getting started
|
|
|
|
### Requirements
|
|
|
|
1. Obtain an API key from [PolygonStocksApi](https://polygon.io).
|
|
2. Find out the exchange symbol of the stock also known as Ticker Symbol of the stock you can google it out and find it (E.x. : Exchange symbol for Microsoft is MSFT)
|
|
3. Choose and verify other options you required for fetching the stock details. [here](https://polygon.io/docs/stocks/get_v2_aggs_ticker__stocksticker__range__multiplier___timespan___from___to).
|
|
|
|
### Setup guide
|
|
|
|
The following fields are required fields for the connector to work:
|
|
- `apiKey`: Your Polygon Stocks API key.
|
|
- `stocksTicker`: The ticker symbol of the `stock/equity`.
|
|
- `multiplier`: The size of the timespan multiplier.
|
|
- `timespan`: The
|
|
- `from`: The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
|
|
- `to`: The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
|
|
- (optional) `adjusted`: determines whether or not the results are adjusted for splits. By default, results are adjusted and set to true. Set this to false to get results that are NOT adjusted for splits.
|
|
- (optional) `sort`: Sort the results by timestamp. asc will return results in ascending order (oldest at the top), desc will return results in descending order (newest at the top).
|
|
- (optional) `limit`: Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on Aggregate Data API Improvements [Find-more](https://polygon.io/blog/aggs-api-updates/).
|
|
|
|
|
|
|
|
|
|
|
|
## Changelog
|
|
|
|
| Version | Date | Pull Request | Subject |
|
|
|:--------|:-----------|:---------------------------------------------------------|:-----------|
|
|
| 0.1.0 | 2022-11-02 | [18842](https://github.com/airbytehq/airbyte/pull/18842) | New source |
|