Overview
Configuration is provided for establishing connections with OANDA service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resources.
Insert data
Use REST Destination component to insert data into service resource.
Manage remote files and directories
Use File Transfer Task to manage remote files and directories.
Configuration
Base URL address: https://exchange-rates-api.oanda.com/v2.
- APIKey
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- APIKey: Required. Specify API key.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
{{=connection.user.APIKey}}
Documentation: https://developer.oanda.com/rest-live-v20/authentication/.
Based on resource template Rate.
- [Read] action
-
Endpoint URL address:
/rates/{{=parameters.base}}.json.
The result is extracted from:{{=Oanda.getRates(response)}}.The action has the following user-defined parameters:
- base: Required. Specify the base currency for all currency pairs in the request.
- data_set: Required. Specify the data set.
- field: Required. Specify expandable fields to be included in response.
- date: Specify a specific quote date in the formay of yyyy-mm-dd. (e.g) 2024-01-10
- start: Specify a start date in the format yyyy-mm-dd calculating average quotes over a date range.
- end: Specify a end date in the format yyyy-mm-dd calculating average quotes over a date range.
The following request parameters will be automatically processed:
-
quote:
{{=Oanda.getQuote(parameters)}} -
fields:
{{=parameters.field.split(',')}}
Documentation: https://developer.oanda.com/exchange-rates-api/#get-/v1/rates/-base-.-ext-.
- base_currency
A key field. Template: ShortText.
- quote_currency
Template: ShortText.
- ask
Data type: DT_R8
- bid
Data type: DT_R8
- date
Template: DateTime.
- high_ask
Data type: DT_R8
- high_bid
Data type: DT_R8
- low_ask
Data type: DT_R8
- low_bid
Data type: DT_R8
- midpoint
Data type: DT_R8
- data_set
Template: ShortText.
- decimal_places
Data type: DT_I4
- fields
Template: LongText. A composite field.
- quote_currencies
Template: LongText. A composite field.
- request_time
Template: DateTime. A read-only field.
- skipped_currencies
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/remaining_quotes.json.
The result is extracted from:{{=[response]}}.Documentation: https://developer.oanda.com/exchange-rates-api/#get-/v2/remaining_quotes.-ext-.
- remaining_quotes
Template: ShortText.
- used_quotes
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/currencies.json.
The result is extracted from:{{=response.currencies}}.The action has the following user-defined parameters:
- data_set: Required. Specify the data set.
Documentation: https://developer.oanda.com/exchange-rates-api/#get-/v2/currencies.-ext-.
- code
Template: ShortText.
- description
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/datasets/{{=parameters.data_set}}.json.
The result is extracted from:{{=response.datasets}}.The action has the following user-defined parameters:
- data_set: Required. Specify the data set.
Documentation: https://developer.oanda.com/exchange-rates-api/#get-/v2/datasets/-dataset-.-ext-.
- code
A key field. Template: ShortText.
- description
Template: ShortText.
- cross_currency
Template: ShortText.
- quotables
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/supported_forwards.json.
The result is extracted from:{{=response.supported_forwards}}.The action has the following user-defined parameters:
- base: Required. Specify the base currency for the quote. Multiple base currencies are comma-separated.
The following request parameters will be automatically processed:
-
base:
{{=parameters.base.split(',')}} -
quote:
{{=Oanda.getQuote(parameters)}}
Documentation: https://developer.oanda.com/exchange-rates-api/#get-/v2/rates/spot.-ext-.
- base_currency
Template: ShortText.
- quote_currency
Template: ShortText.
- tenor
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/rates/spot.json.
The result is extracted from:{{=Oanda.getRates(response)}}.The action has the following user-defined parameters:
- base: Required. Specify the base currency for the quote. Multiple base currencies are comma-separated.
The following request parameters will be automatically processed:
-
base:
{{=parameters.base.split(',')}} -
quote:
{{=Oanda.getQuote(parameters)}}
Documentation: https://developer.oanda.com/exchange-rates-api/#get-/v2/rates/spot.-ext-.
- data_set
Template: ShortText.
- base_currencies
Template: LongText. A composite field.
- quote_currencies
Template: LongText. A composite field.
- date_time
Template: DateTime. A read-only field.
- decimal_places
Data type: DT_I4
- endpoint
Template: ShortText.
- request_time
Template: DateTime. A read-only field.
- skipped_currency_pairs
Template: LongText. A composite field.
- base_currency
Template: ShortText.
- quote_currency
Template: ShortText.
- bid
Data type: DT_R8
- ask
Data type: DT_R8
- midpoint
Data type: DT_R8
Based on resource template Base.
- [Read candles] action
-
Endpoint URL address:
/rates/candles.json.
The result is extracted from:{{=response.quotes}}.The action has the following user-defined parameters:
- base: Required. Specify the base currency. Multiple base currencies are separated by commas.
- start_time: Required. Specify the start time in ISO 8601 format (YYYY-MM-DD or YYYY-MM-DDThh:mm:ss±hh:mm).
- end_time: Required. Specify the end time ISO 8601 format (YYYY-MM-DD or YYYY-MM-DDThh:mm:ss±hh:mm).
- data_set: Required. Specify the data set.
- field: Required. Specify expandable comma-separated fields to be included in response.
The following request parameters will be automatically processed:
-
base:
{{=parameters.base.split(',')}} -
quote:
{{=Oanda.getQuote(parameters)}} -
fields:
{{=parameters.field.split(',')}}
Documentation: https://developer.oanda.com/exchange-rates-api/#get-/v2/rates/candles.-ext-.
- [Read candle] action
-
Endpoint URL address:
/rates/candle.json.
The result is extracted from:{{=response.quotes}}.The action has the following user-defined parameters:
- base: Required. Specify the base currency. Multiple base currencies are separated by commas.
- data_set: Required. Specify the data set.
- field: Required. Specify expandable comma-separated fields to be included in response.
The following request parameters will be automatically processed:
-
base:
{{=parameters.base.split(',')}} -
quote:
{{=Oanda.getQuote(parameters)}} -
fields:
{{=parameters.field.split(',')}}
Documentation: https://developer.oanda.com/exchange-rates-api/#get-/v2/rates/candle.-ext-.
- [Read aggregated] action
-
Endpoint URL address:
/rates/aggregated.json.
The result is extracted from:{{=response.quotes}}.The action has the following user-defined parameters:
- base: Required. Specify the base currency. Multiple base currencies are separated by commas.
- start_time: Required. Specify the start time in ISO 8601 format (YYYY-MM-DD or YYYY-MM-DDThh:mm:ss±hh:mm).
- end_time: Required. Specify the end time ISO 8601 format (YYYY-MM-DD or YYYY-MM-DDThh:mm:ss±hh:mm).
- data_set: Required. Specify the data set.
- field: Required. Specify expandable comma-separated fields to be included in response.
The following request parameters will be automatically processed:
-
base:
{{=parameters.base.split(',')}} -
quote:
{{=Oanda.getQuote(parameters)}} -
fields:
{{=parameters.field.split(',')}}
Documentation: https://developer.oanda.com/exchange-rates-api/#get-/v2/rates/aggregated.-ext-.
- base_currency
Template: ShortText.
- quote_currency
Template: ShortText.
- start_time
Template: ShortText.
- open_time
Template: ShortText.
- close_time
Template: ShortText.
- open_bid
Data type: DT_R8
- open_ask
Data type: DT_R8
- open_midpoint
Data type: DT_R8
- close_bid
Data type: DT_R8
- close_ask
Data type: DT_R8
- close_midpoint
Data type: DT_R8
- average_bid
Data type: DT_R8
- average_ask
Data type: DT_R8
- average_midpoint
Data type: DT_R8
- high_bid
Data type: DT_R8
- high_ask
Data type: DT_R8
- high_midpoint
Data type: DT_R8
- low_bid
Data type: DT_R8
- low_ask
Data type: DT_R8
- low_midpoint
Data type: DT_R8
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/rates/forward.json.
The result is extracted from:{{=response.quotes}}.The action has the following user-defined parameters:
- base: Required. Specify the base currency. Multiple base currencies are separated by commas.
- quote: Required. Specify the quote currency. Multiple quote currencies are separated by commas.
The following request parameters will be automatically processed:
-
base:
{{=parameters.base.split(',')}} -
quote:
{{=Oanda.getQuote(parameters)}}
Documentation: https://developer.oanda.com/exchange-rates-api/#get-/v2/rates/aggregated.-ext-.
- tenor
Template: ShortText.
- spot_bid
Data type: DT_R8
- spot_ask
Data type: DT_R8
- spot_midpoint
Data type: DT_R8
- forward_points_bid
Data type: DT_R8
- forward_points_ask
Data type: DT_R8
- [Read] action
-
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
_includeUserParameters:
- [Create] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
Based on resource template Base.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
Knowledge Base
What's New
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.