1
0
mirror of synced 2025-12-23 21:03:15 -05:00

🎉 New Source: Coin API (#18302)

* Initial commit

* Add streams

* Correct acceptance test config

* Make secret

* Update docsurl

* Remove catalog.json

* Add second stream

* Add default to spec

* Change to start_date and end_date

* Add links to CoinAPI docs in spec

* Change to start_date and end_date

* Add docs

* add coin api to source seed file

* remove icon

* generate source spec for coin api

Co-authored-by: Vincent Koc <koconder@users.noreply.github.com>
Co-authored-by: marcosmarxm <marcosmarxm@gmail.com>
This commit is contained in:
Isaac Harris-Holt
2022-10-27 23:08:41 +01:00
committed by GitHub
parent aea4c5392c
commit 13b4a26a5d
26 changed files with 644 additions and 0 deletions

View File

@@ -0,0 +1,53 @@
# CoinAPI
## Sync overview
This source can sync OHLCV and trades historical data for a single coin listed on
[CoinAPI](https://www.coinapi.io/). It currently only supports Full Refresh
syncs.
### Output schema
This source is capable of syncing the following streams:
* `ohlcv_historical_data`
* `trades_historical_data`
### Features
| Feature | Supported? \(Yes/No\) | Notes |
|:------------------|:----------------------|:--------------------------------------------------------|
| Full Refresh Sync | Yes | |
| Incremental Sync | No | |
| API Environments | Yes | Both sandbox and production environments are supported. |
### Performance considerations
CoinAPI allows only 100 daily requests on the free plan. Use of this connector
may require a paid plan.
## Getting started
### Requirements
1. Obtain an API key from [CoinAPI](https://www.coinapi.io/).
2. Choose a symbol to pull data for. You can find a list of symbols [here](https://docs.coinapi.io/#list-all-symbols-get).
3. Choose a time interval to pull data for. You can find a list of intervals [here](https://docs.coinapi.io/#list-all-periods-get).
### Setup guide
The following fields are required fields for the connector to work:
- `api_key`: Your CoinAPI API key.
- `environment`: The environment to use. Can be either `sandbox` or `production`.
- `symbol_id`: The symbol to pull data for.
- `period`: The time interval to pull data for.
- `start_date`: The start date to pull `history` data from.
- (optional) `end_date`: The end date to pull `history` data until.
- (optional) `limit`: The maximum number of records to pull per request. Defaults to 100.
## Changelog
| Version | Date | Pull Request | Subject |
|:--------|:-----------|:---------------------------------------------------------|:-----------|
| 0.1.0 | 2022-10-21 | [18302](https://github.com/airbytehq/airbyte/pull/18302) | New source |