Availability

Airbyte Cloud Airbyte OSS PyAirbyte

Support Level

Community

Latest Version

1.3.0

Exchange Rates API

This page contains the setup guide and reference information for the Exchange Rates API source connector.

Overview

The Exchange Rates API integration is a toy integration to demonstrate how Airbyte works with a very simple source.

Prerequisites

• Exchange Rates API account
• API Access Key

Setup Guide

Step 1: Set up Exchange Rates API

1. Create an account with Exchange Rates API.
2. Navigate to the Exchange Rates API Dashboard to find your API Access Key.

note

If you have a free subscription plan, you will have two limitations to the plan:

1. Limit of 1,000 API calls per month
2. You won't be able to specify the base parameter, meaning that you will be only be allowed to use the default base value which is EUR.

Step 2: Set up the Exchange Rates connector in Airbyte

1. Enter a Name for your source.
2. Enter your API key as the access_key from the prerequisites.
3. Enter the Start Date in YYYY-MM-DD format. The data added on and after this date will be replicated.
4. (Optional) Enter a base currency. For those on the free plan, EUR is the only option available. If none are specified, EUR will be used.
5. Click Set up source.

Supported sync modes

Feature	Supported?
Full Refresh Sync	Yes
Incremental - Append Sync	Yes
Namespaces	No

Supported streams

It contains one stream: exchange_rates

Each record in the stream contains many fields:

• The date of the record.
• One field for every supported currency which contain the value of that currency on that date.

Data type map

Field	Airbyte Type
Currency	number
Date	string

Limitations & Troubleshooting

Expand to see details about Exchange Rates API connector limitations and troubleshooting.

Connector limitations

Rate limiting

The Exchange Rates API has rate limits that vary per pricing plan. The free plan is subject to rate limiting of 1,000 requests per month. Review the Exchange Rates API Pricing Plans for more information.

Troubleshooting

• With the free plan, you won't be able to specify the base parameter, meaning that you will be only be allowed to use the default base value which is EUR.
• Check out common troubleshooting issues for the Exchange Rates API source connector on our Airbyte Forum.

Reference

Config fields reference

Field

Type

Property name

string

start_date

string

access_key

string

base

boolean

ignore_weekends

Changelog

Version	Date	Pull Request	Subject
1.3.0	2023-08-25	29299	Migrate to low-code
1.2.9	2023-08-15	23000	Fix schema and tests
1.2.8	2023-02-14	23000	Specified date formatting in specification
1.2.7	2022-10-31	18726	Fix handling error during check connection
1.2.6	2022-08-23	15884	Migrated to new API Layer endpoint
0.2.6	2022-04-20	12230	Update connector to use a spec.yaml
0.2.5	2021-11-12	7936	Add ignore_weekends boolean option
0.2.4	2021-11-08	7499	Remove base-python dependencies
0.2.3	2021-06-06	3973	Add AIRBYTE_ENTRYPOINT for kubernetes support
0.2.2	2021-05-28	3677	Adding clearer error message when a currency isn't supported. access_key field in spec.json was marked as sensitive
0.2.0	2021-05-26	3566	Move from api.ratesapi.io/ to api.exchangeratesapi.io/. Add required field access_key to config.json.
0.1.0	2021-04-19	2942	Implement Exchange API using the CDK