CoinAPI
Sync overview
This source can sync OHLCV and trades historical data for a single coin listed on CoinAPI. 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
- Obtain an API key from CoinAPI.
- Choose a symbol to pull data for. You can find a list of symbols here.
- Choose a time interval to pull data for. You can find a list of intervals here.
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 eithersandbox
orproduction
.symbol_id
: The symbol to pull data for.period
: The time interval to pull data for.start_date
: The start date to pullhistory
data from.- (optional)
end_date
: The end date to pullhistory
data until. - (optional)
limit
: The maximum number of records to pull per request. Defaults to 100.
Reference
Config fields reference
Field
Type
Property name
string
api_key
string
environment
string
symbol_id
string
period
string
start_date
string
end_date
integer
limit
Changelog
Version | Date | Pull Request | Subject |
---|---|---|---|
0.2.0 | 2024-02-05 | #34826 | Fix catalog types for fields bid_price and bid_size in stream quotes_historical_data . |
0.1.1 | 2022-12-19 | #20600 | Add quotes historical data stream |
0.1.0 | 2022-10-21 | #18302 | New source |