Skip to main content

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

FeatureSupported? (Yes/No)Notes
Full Refresh SyncYes
Incremental SyncNo
API EnvironmentsYesBoth 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.
  2. Choose a symbol to pull data for. You can find a list of symbols here.
  3. 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 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.

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

Expand to review
VersionDatePull RequestSubject
0.2.162024-08-1043507Update dependencies
0.2.152024-08-0343091Update dependencies
0.2.142024-07-2742599Update dependencies
0.2.132024-07-2042238Update dependencies
0.2.122024-07-1341763Update dependencies
0.2.112024-07-1041488Update dependencies
0.2.102024-07-0941206Update dependencies
0.2.92024-07-0640976Update dependencies
0.2.82024-06-2640315Update dependencies
0.2.72024-06-2240062Update dependencies
0.2.62024-06-0639257[autopull] Upgrade base image to v1.2.2
0.2.52024-05-2138139Make connector compatable with builder `
0.2.42024-04-1937138Updating to 0.80.0 CDK
0.2.32024-04-1837138Manage dependencies with Poetry.
0.2.22024-04-1537138Base image migration: remove Dockerfile and use the python-connector-base image
0.2.12024-04-1237138schema descriptions
0.2.02024-02-05#34826Fix catalog types for fields bid_price and bid_size in stream quotes_historical_data.
0.1.12022-12-19#20600Add quotes historical data stream
0.1.02022-10-21#18302New source