Get Historical Prices with OANDA API on Exchange Rate Updated from CurrencyScoop API

Pipedream makes it easy to connect APIs for OANDA, CurrencyScoop and 2,500+ other apps remarkably fast.

Trigger workflow on

Exchange Rate Updated from the CurrencyScoop API

Next, do this

Get Historical Prices with the OANDA API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a CurrencyScoop trigger and OANDA action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Exchange Rate Updated trigger
1. Connect your CurrencyScoop account
2. Configure timer
3. Select a Base Currency
4. Select a Target Currency
5. Optional- Configure Threshold
Configure the Get Historical Prices action
1. Connect your OANDA account
2. Configure Is Demo
3. Select a Account ID
4. Configure Instrument Name
5. Configure Start Time
6. Configure End Time
7. Optional- Configure Price
8. Optional- Select a Granularity
9. Optional- Configure Smooth
10. Optional- Configure Include First
11. Optional- Configure Daily Alignment
12. Optional- Configure Alignment Timezone
13. Optional- Select a Weekly Alignment
14. Optional- Configure Units
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

Exchange Rate Updated on CurrencyScoop

Description:Emit new event when the exchange rate for a currency is updated [See the documentation](https://currencybeacon.com/api-documentation)

Version:0.0.1

Key:currencyscoop-exchange-rate-updated

View on GitHub

CurrencyScoop Overview#

The CurrencyScoop API offers real-time and historical exchange rate data, as well as currency conversion and time-series data. By integrating with Pipedream, users can create automated workflows that react to currency fluctuations, update pricing in their apps, or generate financial reports. Pipedream's serverless architecture enables running these workflows on a schedule or in response to certain triggers without managing any infrastructure.

Trigger Code#

import { defineSource } from "@pipedream/types";
import app from "../../app/currencyscoop.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
export default defineSource({
    key: "currencyscoop-exchange-rate-updated",
    name: "Exchange Rate Updated",
    description: "Emit new event when the exchange rate for a currency is updated [See the documentation](https://currencybeacon.com/api-documentation)",
    version: "0.0.1",
    type: "source",
    dedupe: "unique",
    props: {
        app,
        timer: {
            type: "$.interface.timer",
            default: {
                intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
            },
        },
        db: "$.service.db",
        base: {
            propDefinition: [
                app,
                "currency",
            ],
        },
        targetCurrency: {
            propDefinition: [
                app,
                "targetCurrency",
            ],
        },
        threshold: {
            type: "string",
            label: "Threshold",
            description: "If specified, a new event will only be emitted when the rate has changed by at least this amount since the last event. For example, if `Threshold` is **0.2** and the initial rate obtained is **3.0**, a new event will only be emitted when it reaches **2.8** or **3.2**.",
            optional: true,
        },
    },
    hooks: {
        async deploy() {
            await this.getAndProcessData();
        },
    },
    methods: {
        setLastValue(value) {
            this.db.set("lastValue", value);
        },
        getLastValue() {
            return this.db.get("lastValue");
        },
        setLastConfig(value) {
            this.db.set("lastConfig", value);
        },
        getLastConfig() {
            return this.db.get("lastConfig");
        },
        async getAndProcessData() {
            const { base, targetCurrency, threshold, } = this;
            const params = {
                $: this,
                params: {
                    base,
                    symbols: targetCurrency,
                },
            };
            const response = await this.app.getLatestRates(params);
            const { response: { rates } } = response;
            const value = rates[targetCurrency];
            const currentConfig = [
                base,
                targetCurrency,
            ].join();
            const lastConfig = this.getLastConfig();
            if (currentConfig === lastConfig) {
                const lastValue = this.getLastValue();
                if (lastValue) {
                    const variation = Math.abs(value - lastValue);
                    if (!variation || (threshold && variation < Math.abs(Number(threshold))))
                        return;
                }
            }
            this.setLastConfig(currentConfig);
            this.setLastValue(value);
            this.emitEvent(response);
        },
        emitEvent(data) {
            const { response: { date: ts, base, rates, }, } = data;
            const [name, amount,] = Object.entries(rates)[0];
            this.$emit(data, {
                id: ts,
                summary: `New rate: 1 ${base} = ${amount} ${name}`,
                ts,
            });
        },
    },
    async run() {
        await this.getAndProcessData();
    },
});

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
CurrencyScoop	`app`	`app`	This component uses the CurrencyScoop app.
	`timer`	`$.interface.timer`
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Base Currency	`base`	`string`	Select a value from the drop down menu:`{ "label": "United Arab Emirates dirham", "value": "AED" }{ "label": "Afghan afghani", "value": "AFN" }{ "label": "Albanian lek", "value": "ALL" }{ "label": "Armenian dram", "value": "AMD" }{ "label": "Netherlands Antillean guilder", "value": "ANG" }{ "label": "Angolan kwanza", "value": "AOA" }{ "label": "Argentine peso", "value": "ARS" }{ "label": "Australian dollar", "value": "AUD" }{ "label": "Aruban florin", "value": "AWG" }{ "label": "Azerbaijani manat", "value": "AZN" }{ "label": "Bosnia and Herzegovina convertible mark", "value": "BAM" }{ "label": "Barbados dollar", "value": "BBD" }{ "label": "Bangladeshi taka", "value": "BDT" }{ "label": "Bulgarian lev", "value": "BGN" }{ "label": "Bahraini dinar", "value": "BHD" }{ "label": "Burundian franc", "value": "BIF" }{ "label": "Bermudian dollar", "value": "BMD" }{ "label": "Brunei dollar", "value": "BND" }{ "label": "Boliviano", "value": "BOB" }{ "label": "Brazilian real", "value": "BRL" }{ "label": "Bahamian dollar", "value": "BSD" }{ "label": "Bhutanese ngultrum", "value": "BTN" }{ "label": "Botswana pula", "value": "BWP" }{ "label": "Belarusian ruble", "value": "BYN" }{ "label": "Belize dollar", "value": "BZD" }{ "label": "Canadian dollar", "value": "CAD" }{ "label": "Congolese franc", "value": "CDF" }{ "label": "Swiss franc", "value": "CHF" }{ "label": "Unidad de Fomento (funds code)", "value": "CLF" }{ "label": "Chilean peso", "value": "CLP" }{ "label": "Renminbi (Chinese) yuan", "value": "CNY" }{ "label": "Colombian peso", "value": "COP" }{ "label": "Costa Rican colon", "value": "CRC" }{ "label": "Cuban convertible peso", "value": "CUC" }{ "label": "Cuban peso", "value": "CUP" }{ "label": "Cape Verdean escudo", "value": "CVE" }{ "label": "Czech koruna", "value": "CZK" }{ "label": "Djiboutian franc", "value": "DJF" }{ "label": "Danish krone", "value": "DKK" }{ "label": "Dominican peso", "value": "DOP" }{ "label": "Algerian dinar", "value": "DZD" }{ "label": "Egyptian pound", "value": "EGP" }{ "label": "Eritrean nakfa", "value": "ERN" }{ "label": "Ethiopian birr", "value": "ETB" }{ "label": "Euro", "value": "EUR" }{ "label": "Fiji dollar", "value": "FJD" }{ "label": "Falkland Islands pound", "value": "FKP" }{ "label": "Pound sterling", "value": "GBP" }{ "label": "Georgian lari", "value": "GEL" }{ "label": "Ghanaian cedi", "value": "GHS" }{ "label": "Gibraltar pound", "value": "GIP" }{ "label": "Gambian dalasi", "value": "GMD" }{ "label": "Guinean franc", "value": "GNF" }{ "label": "Guatemalan quetzal", "value": "GTQ" }{ "label": "Guyanese dollar", "value": "GYD" }{ "label": "Hong Kong dollar", "value": "HKD" }{ "label": "Honduran lempira", "value": "HNL" }{ "label": "Croatian kuna", "value": "HRK" }{ "label": "Haitian gourde", "value": "HTG" }{ "label": "Hungarian forint", "value": "HUF" }{ "label": "Indonesian rupiah", "value": "IDR" }{ "label": "Israeli new shekel", "value": "ILS" }{ "label": "Indian rupee", "value": "INR" }{ "label": "Iraqi dinar", "value": "IQD" }{ "label": "Iranian rial", "value": "IRR" }{ "label": "Icelandic króna", "value": "ISK" }{ "label": "Jamaican dollar", "value": "JMD" }{ "label": "Jordanian dinar", "value": "JOD" }{ "label": "Japanese yen", "value": "JPY" }{ "label": "Kenyan shilling", "value": "KES" }{ "label": "Kyrgyzstani som", "value": "KGS" }{ "label": "Cambodian riel", "value": "KHR" }{ "label": "Comoro franc", "value": "KMF" }{ "label": "North Korean won", "value": "KPW" }{ "label": "South Korean won", "value": "KRW" }{ "label": "Kuwaiti dinar", "value": "KWD" }{ "label": "Cayman Islands dollar", "value": "KYD" }{ "label": "Kazakhstani tenge", "value": "KZT" }{ "label": "Lao kip", "value": "LAK" }{ "label": "Lebanese pound", "value": "LBP" }{ "label": "Sri Lankan rupee", "value": "LKR" }{ "label": "Liberian dollar", "value": "LRD" }{ "label": "Lesotho loti", "value": "LSL" }{ "label": "Libyan dinar", "value": "LYD" }{ "label": "Moroccan dirham", "value": "MAD" }{ "label": "Moldovan leu", "value": "MDL" }{ "label": "Malagasy ariary", "value": "MGA" }{ "label": "Macedonian denar", "value": "MKD" }{ "label": "Myanmar kyat", "value": "MMK" }{ "label": "Mongolian tögrög", "value": "MNT" }{ "label": "Macanese pataca", "value": "MOP" }{ "label": "Mauritanian ouguiya", "value": "MRU" }{ "label": "Mauritian rupee", "value": "MUR" }{ "label": "Maldivian rufiyaa", "value": "MVR" }{ "label": "Malawian kwacha", "value": "MWK" }{ "label": "Mexican peso", "value": "MXN" }{ "label": "Mexican Unidad de Inversion (UDI) (funds code)", "value": "MXV" }{ "label": "Malaysian ringgit", "value": "MYR" }{ "label": "Mozambican metical", "value": "MZN" }{ "label": "Namibian dollar", "value": "NAD" }{ "label": "Nigerian naira", "value": "NGN" }{ "label": "Nicaraguan córdoba", "value": "NIO" }{ "label": "Norwegian krone", "value": "NOK" }{ "label": "Nepalese rupee", "value": "NPR" }{ "label": "New Zealand dollar", "value": "NZD" }{ "label": "Omani rial", "value": "OMR" }{ "label": "Panamanian balboa", "value": "PAB" }{ "label": "Peruvian sol", "value": "PEN" }{ "label": "Papua New Guinean kina", "value": "PGK" }{ "label": "Philippine peso[13]", "value": "PHP" }{ "label": "Pakistani rupee", "value": "PKR" }{ "label": "Polish złoty", "value": "PLN" }{ "label": "Paraguayan guaraní", "value": "PYG" }{ "label": "Qatari riyal", "value": "QAR" }{ "label": "Romanian leu", "value": "RON" }{ "label": "Serbian dinar", "value": "RSD" }{ "label": "Russian ruble", "value": "RUB" }{ "label": "Rwandan franc", "value": "RWF" }{ "label": "Saudi riyal", "value": "SAR" }{ "label": "Solomon Islands dollar", "value": "SBD" }{ "label": "Seychelles rupee", "value": "SCR" }{ "label": "Sudanese pound", "value": "SDG" }{ "label": "Swedish krona/kronor", "value": "SEK" }{ "label": "Singapore dollar", "value": "SGD" }{ "label": "Saint Helena pound", "value": "SHP" }{ "label": "Sierra Leonean leone", "value": "SLL" }{ "label": "Somali shilling", "value": "SOS" }{ "label": "Surinamese dollar", "value": "SRD" }{ "label": "São Tomé and Príncipe dobra", "value": "STN" }{ "label": "Salvadoran colón", "value": "SVC" }{ "label": "Syrian pound", "value": "SYP" }{ "label": "Swazi lilangeni", "value": "SZL" }{ "label": "Thai baht", "value": "THB" }{ "label": "Tajikistani somoni", "value": "TJS" }{ "label": "Turkmenistan manat", "value": "TMT" }{ "label": "Tunisian dinar", "value": "TND" }{ "label": "Tongan paʻanga", "value": "TOP" }{ "label": "Turkish lira", "value": "TRY" }{ "label": "Trinidad and Tobago dollar", "value": "TTD" }{ "label": "New Taiwan dollar", "value": "TWD" }{ "label": "Tanzanian shilling", "value": "TZS" }{ "label": "Ukrainian hryvnia", "value": "UAH" }{ "label": "Ugandan shilling", "value": "UGX" }{ "label": "United States dollar", "value": "USD" }{ "label": "Uruguayan peso", "value": "UYU" }{ "label": "Uzbekistan som", "value": "UZS" }{ "label": "Venezuelan bolívar soberano[13]", "value": "VES" }{ "label": "Vietnamese đồng", "value": "VND" }{ "label": "Vanuatu vatu", "value": "VUV" }{ "label": "Samoan tala", "value": "WST" }{ "label": "CFA franc BEAC", "value": "XAF" }{ "label": "Silver (one troy ounce)", "value": "XAG" }{ "label": "Gold (one troy ounce)", "value": "XAU" }{ "label": "East Caribbean dollar", "value": "XCD" }{ "label": "Special drawing rights", "value": "XDR" }{ "label": "CFA franc BCEAO", "value": "XOF" }{ "label": "Palladium (one troy ounce)", "value": "XPD" }{ "label": "CFP franc (franc Pacifique)", "value": "XPF" }{ "label": "Platinum (one troy ounce)", "value": "XPT" }{ "label": "Yemeni rial", "value": "YER" }{ "label": "South African rand", "value": "ZAR" }{ "label": "Zambian kwacha", "value": "ZMW" }{ "label": "Zimbabwean dollar", "value": "ZWL" }`
Target Currency	`targetCurrency`	`string`	Select a value from the drop down menu:`{ "label": "United Arab Emirates dirham", "value": "AED" }{ "label": "Afghan afghani", "value": "AFN" }{ "label": "Albanian lek", "value": "ALL" }{ "label": "Armenian dram", "value": "AMD" }{ "label": "Netherlands Antillean guilder", "value": "ANG" }{ "label": "Angolan kwanza", "value": "AOA" }{ "label": "Argentine peso", "value": "ARS" }{ "label": "Australian dollar", "value": "AUD" }{ "label": "Aruban florin", "value": "AWG" }{ "label": "Azerbaijani manat", "value": "AZN" }{ "label": "Bosnia and Herzegovina convertible mark", "value": "BAM" }{ "label": "Barbados dollar", "value": "BBD" }{ "label": "Bangladeshi taka", "value": "BDT" }{ "label": "Bulgarian lev", "value": "BGN" }{ "label": "Bahraini dinar", "value": "BHD" }{ "label": "Burundian franc", "value": "BIF" }{ "label": "Bermudian dollar", "value": "BMD" }{ "label": "Brunei dollar", "value": "BND" }{ "label": "Boliviano", "value": "BOB" }{ "label": "Brazilian real", "value": "BRL" }{ "label": "Bahamian dollar", "value": "BSD" }{ "label": "Bhutanese ngultrum", "value": "BTN" }{ "label": "Botswana pula", "value": "BWP" }{ "label": "Belarusian ruble", "value": "BYN" }{ "label": "Belize dollar", "value": "BZD" }{ "label": "Canadian dollar", "value": "CAD" }{ "label": "Congolese franc", "value": "CDF" }{ "label": "Swiss franc", "value": "CHF" }{ "label": "Unidad de Fomento (funds code)", "value": "CLF" }{ "label": "Chilean peso", "value": "CLP" }{ "label": "Renminbi (Chinese) yuan", "value": "CNY" }{ "label": "Colombian peso", "value": "COP" }{ "label": "Costa Rican colon", "value": "CRC" }{ "label": "Cuban convertible peso", "value": "CUC" }{ "label": "Cuban peso", "value": "CUP" }{ "label": "Cape Verdean escudo", "value": "CVE" }{ "label": "Czech koruna", "value": "CZK" }{ "label": "Djiboutian franc", "value": "DJF" }{ "label": "Danish krone", "value": "DKK" }{ "label": "Dominican peso", "value": "DOP" }{ "label": "Algerian dinar", "value": "DZD" }{ "label": "Egyptian pound", "value": "EGP" }{ "label": "Eritrean nakfa", "value": "ERN" }{ "label": "Ethiopian birr", "value": "ETB" }{ "label": "Euro", "value": "EUR" }{ "label": "Fiji dollar", "value": "FJD" }{ "label": "Falkland Islands pound", "value": "FKP" }{ "label": "Pound sterling", "value": "GBP" }{ "label": "Georgian lari", "value": "GEL" }{ "label": "Ghanaian cedi", "value": "GHS" }{ "label": "Gibraltar pound", "value": "GIP" }{ "label": "Gambian dalasi", "value": "GMD" }{ "label": "Guinean franc", "value": "GNF" }{ "label": "Guatemalan quetzal", "value": "GTQ" }{ "label": "Guyanese dollar", "value": "GYD" }{ "label": "Hong Kong dollar", "value": "HKD" }{ "label": "Honduran lempira", "value": "HNL" }{ "label": "Croatian kuna", "value": "HRK" }{ "label": "Haitian gourde", "value": "HTG" }{ "label": "Hungarian forint", "value": "HUF" }{ "label": "Indonesian rupiah", "value": "IDR" }{ "label": "Israeli new shekel", "value": "ILS" }{ "label": "Indian rupee", "value": "INR" }{ "label": "Iraqi dinar", "value": "IQD" }{ "label": "Iranian rial", "value": "IRR" }{ "label": "Icelandic króna", "value": "ISK" }{ "label": "Jamaican dollar", "value": "JMD" }{ "label": "Jordanian dinar", "value": "JOD" }{ "label": "Japanese yen", "value": "JPY" }{ "label": "Kenyan shilling", "value": "KES" }{ "label": "Kyrgyzstani som", "value": "KGS" }{ "label": "Cambodian riel", "value": "KHR" }{ "label": "Comoro franc", "value": "KMF" }{ "label": "North Korean won", "value": "KPW" }{ "label": "South Korean won", "value": "KRW" }{ "label": "Kuwaiti dinar", "value": "KWD" }{ "label": "Cayman Islands dollar", "value": "KYD" }{ "label": "Kazakhstani tenge", "value": "KZT" }{ "label": "Lao kip", "value": "LAK" }{ "label": "Lebanese pound", "value": "LBP" }{ "label": "Sri Lankan rupee", "value": "LKR" }{ "label": "Liberian dollar", "value": "LRD" }{ "label": "Lesotho loti", "value": "LSL" }{ "label": "Libyan dinar", "value": "LYD" }{ "label": "Moroccan dirham", "value": "MAD" }{ "label": "Moldovan leu", "value": "MDL" }{ "label": "Malagasy ariary", "value": "MGA" }{ "label": "Macedonian denar", "value": "MKD" }{ "label": "Myanmar kyat", "value": "MMK" }{ "label": "Mongolian tögrög", "value": "MNT" }{ "label": "Macanese pataca", "value": "MOP" }{ "label": "Mauritanian ouguiya", "value": "MRU" }{ "label": "Mauritian rupee", "value": "MUR" }{ "label": "Maldivian rufiyaa", "value": "MVR" }{ "label": "Malawian kwacha", "value": "MWK" }{ "label": "Mexican peso", "value": "MXN" }{ "label": "Mexican Unidad de Inversion (UDI) (funds code)", "value": "MXV" }{ "label": "Malaysian ringgit", "value": "MYR" }{ "label": "Mozambican metical", "value": "MZN" }{ "label": "Namibian dollar", "value": "NAD" }{ "label": "Nigerian naira", "value": "NGN" }{ "label": "Nicaraguan córdoba", "value": "NIO" }{ "label": "Norwegian krone", "value": "NOK" }{ "label": "Nepalese rupee", "value": "NPR" }{ "label": "New Zealand dollar", "value": "NZD" }{ "label": "Omani rial", "value": "OMR" }{ "label": "Panamanian balboa", "value": "PAB" }{ "label": "Peruvian sol", "value": "PEN" }{ "label": "Papua New Guinean kina", "value": "PGK" }{ "label": "Philippine peso[13]", "value": "PHP" }{ "label": "Pakistani rupee", "value": "PKR" }{ "label": "Polish złoty", "value": "PLN" }{ "label": "Paraguayan guaraní", "value": "PYG" }{ "label": "Qatari riyal", "value": "QAR" }{ "label": "Romanian leu", "value": "RON" }{ "label": "Serbian dinar", "value": "RSD" }{ "label": "Russian ruble", "value": "RUB" }{ "label": "Rwandan franc", "value": "RWF" }{ "label": "Saudi riyal", "value": "SAR" }{ "label": "Solomon Islands dollar", "value": "SBD" }{ "label": "Seychelles rupee", "value": "SCR" }{ "label": "Sudanese pound", "value": "SDG" }{ "label": "Swedish krona/kronor", "value": "SEK" }{ "label": "Singapore dollar", "value": "SGD" }{ "label": "Saint Helena pound", "value": "SHP" }{ "label": "Sierra Leonean leone", "value": "SLL" }{ "label": "Somali shilling", "value": "SOS" }{ "label": "Surinamese dollar", "value": "SRD" }{ "label": "São Tomé and Príncipe dobra", "value": "STN" }{ "label": "Salvadoran colón", "value": "SVC" }{ "label": "Syrian pound", "value": "SYP" }{ "label": "Swazi lilangeni", "value": "SZL" }{ "label": "Thai baht", "value": "THB" }{ "label": "Tajikistani somoni", "value": "TJS" }{ "label": "Turkmenistan manat", "value": "TMT" }{ "label": "Tunisian dinar", "value": "TND" }{ "label": "Tongan paʻanga", "value": "TOP" }{ "label": "Turkish lira", "value": "TRY" }{ "label": "Trinidad and Tobago dollar", "value": "TTD" }{ "label": "New Taiwan dollar", "value": "TWD" }{ "label": "Tanzanian shilling", "value": "TZS" }{ "label": "Ukrainian hryvnia", "value": "UAH" }{ "label": "Ugandan shilling", "value": "UGX" }{ "label": "United States dollar", "value": "USD" }{ "label": "Uruguayan peso", "value": "UYU" }{ "label": "Uzbekistan som", "value": "UZS" }{ "label": "Venezuelan bolívar soberano[13]", "value": "VES" }{ "label": "Vietnamese đồng", "value": "VND" }{ "label": "Vanuatu vatu", "value": "VUV" }{ "label": "Samoan tala", "value": "WST" }{ "label": "CFA franc BEAC", "value": "XAF" }{ "label": "Silver (one troy ounce)", "value": "XAG" }{ "label": "Gold (one troy ounce)", "value": "XAU" }{ "label": "East Caribbean dollar", "value": "XCD" }{ "label": "Special drawing rights", "value": "XDR" }{ "label": "CFA franc BCEAO", "value": "XOF" }{ "label": "Palladium (one troy ounce)", "value": "XPD" }{ "label": "CFP franc (franc Pacifique)", "value": "XPF" }{ "label": "Platinum (one troy ounce)", "value": "XPT" }{ "label": "Yemeni rial", "value": "YER" }{ "label": "South African rand", "value": "ZAR" }{ "label": "Zambian kwacha", "value": "ZMW" }{ "label": "Zimbabwean dollar", "value": "ZWL" }`
Threshold	`threshold`	`string`	If specified, a new event will only be emitted when the rate has changed by at least this amount since the last event. For example, if `Threshold` is 0.2 and the initial rate obtained is 3.0, a new event will only be emitted when it reaches 2.8 or 3.2.

Trigger Authentication#

CurrencyScoop uses API keys for authentication. When you connect your CurrencyScoop account, Pipedream securely stores the keys so you can easily authenticate to CurrencyScoop APIs in both code and no-code steps.

About CurrencyScoop#

CurrencyBeacon is a developer friendly, easy-to-use REST API with real-time and historical exchange rates for fiat currencies and cryptocurrencies.

Action#

Get Historical Prices on OANDA

Description:Retrieve historical price data for a specified currency pair or instrument within a given time range. [See the documentation](https://developer.oanda.com/rest-live-v20/pricing-ep/)

Version:0.0.1

Key:oanda-get-historical-prices

View on GitHub

OANDA Overview#

The OANDA API enables you to tap into the world of forex trading, providing real-time currency exchange rates, and the ability to automate trading strategies, manage accounts, access market data, and more. On Pipedream, you can craft workflows that capitalize on OANDA's capabilities, such as reacting to market changes, automating trades based on custom logic, and syncing forex data with other business applications for analysis and decision-making.

Action Code#

import oanda from "../../oanda.app.mjs";
import constants from "../../common/constants.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "oanda-get-historical-prices",
  name: "Get Historical Prices",
  description: "Retrieve historical price data for a specified currency pair or instrument within a given time range. [See the documentation](https://developer.oanda.com/rest-live-v20/pricing-ep/)",
  version: "0.0.1",
  type: "action",
  props: {
    oanda,
    isDemo: {
      propDefinition: [
        oanda,
        "isDemo",
      ],
    },
    accountId: {
      propDefinition: [
        oanda,
        "accountId",
        (c) => ({
          isDemo: c.isDemo,
        }),
      ],
    },
    instrument: {
      propDefinition: [
        oanda,
        "instrument",
      ],
    },
    startTime: {
      type: "string",
      label: "Start Time",
      description: "The start time for historical price data (ISO 8601 format). E.g. `2025-04-01T04:00:00.000000000Z`",
    },
    endTime: {
      type: "string",
      label: "End Time",
      description: "The end time for historical price data (ISO 8601 format). E.g. `2025-04-01T04:00:00.000000000Z`",
    },
    price: {
      type: "string",
      label: "Price",
      description: "The Price component(s) to get candlestick data for. Can contain any combination of the characters “M” (midpoint candles) “B” (bid candles) and “A” (ask candles).",
      optional: true,
    },
    granularity: {
      type: "string",
      label: "Granularity",
      description: "The granularity of the candlesticks to fetch",
      options: constants.CANDLE_GRANULARITIES,
      optional: true,
    },
    smooth: {
      type: "boolean",
      label: "Smooth",
      description: "A flag that controls whether the candlestick is “smoothed” or not. A smoothed candlestick uses the previous candle’s close price as its open price, while an unsmoothed candlestick uses the first price from its time range as its open price.",
      optional: true,
    },
    includeFirst: {
      type: "boolean",
      label: "Include First",
      description: "A flag that controls whether the candlestick that is covered by the from time should be included in the results. This flag enables clients to use the timestamp of the last completed candlestick received to poll for future candlesticks but avoid receiving the previous candlestick repeatedly.",
      optional: true,
    },
    dailyAlignment: {
      type: "integer",
      label: "Daily Alignment",
      description: "The hour of the day (in the specified timezone) to use for granularities that have daily alignments. minimum=0, maximum=23",
      optional: true,
    },
    alignmentTimezone: {
      type: "string",
      label: "Alignment Timezone",
      description: "The timezone to use for the dailyAlignment parameter. Candlesticks with daily alignment will be aligned to the dailyAlignment hour within the alignmentTimezone. Note that the returned times will still be represented in UTC. [default=America/New_York]",
      optional: true,
    },
    weeklyAlignment: {
      type: "string",
      label: "Weekly Alignment",
      description: "The day of the week used for granularities that have weekly alignment. [default=Friday]",
      options: constants.WEEKLY_ALIGNMENT_DAYS,
      optional: true,
    },
    units: {
      type: "integer",
      label: "Units",
      description: "The number of units used to calculate the volume-weighted average bid and ask prices in the returned candles. [default=1]",
      optional: true,
    },
  },
  async run({ $ }) {
    try {
      const response = await this.oanda.getHistoricalPrices({
        $,
        isDemo: this.isDemo,
        accountId: this.accountId,
        instrument: this.instrument,
        params: {
          price: this.price,
          granularity: this.granularity,
          from: this.startTime,
          to: this.endTime,
          smooth: this.smooth,
          includeFirst: this.includeFirst,
          dailyAlignment: this.dailyAlignment,
          alignmentTimezone: this.alignmentTimezone,
          weeklyAlignment: this.weeklyAlignment,
          units: this.units,
        },
      });
      $.export("$summary", `Successfully retrieved ${response.candles.length} trade${response.candles.length === 1
        ? ""
        : "s"}`);
      return response;
    } catch (error) {
      if (error?.message.includes("Maximum value for 'count' exceeded")) {
        throw new ConfigurationError("Maximum results exceeded. Update the time range or granularity to return fewer results.");
      } else {
        console.error("Error retrieving historical prices:", error);
        throw error;
      }
    }
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
OANDA	`oanda`	`app`	This component uses the OANDA app.
Is Demo	`isDemo`	`boolean`	Set to `true` if using a demo/practice account
Account ID	`accountId`	`string`	Select a value from the drop down menu.
Instrument Name	`instrument`	`string`	The instrument to filter the requested Trades by. E.g. `AUD_USD`
Start Time	`startTime`	`string`	The start time for historical price data (ISO 8601 format). E.g. `2025-04-01T04:00:00.000000000Z`
End Time	`endTime`	`string`	The end time for historical price data (ISO 8601 format). E.g. `2025-04-01T04:00:00.000000000Z`
Price	`price`	`string`	The Price component(s) to get candlestick data for. Can contain any combination of the characters “M” (midpoint candles) “B” (bid candles) and “A” (ask candles).
Granularity	`granularity`	`string`	Select a value from the drop down menu:`{ "value": "S5", "label": "5 second candlesticks, minute alignment" }{ "value": "S10", "label": "10 second candlesticks, minute alignment" }{ "value": "S15", "label": "15 second candlesticks, minute alignment" }{ "value": "S30", "label": "30 second candlesticks, minute alignment" }{ "value": "M1", "label": "1 minute candlesticks, minute alignment" }{ "value": "M2", "label": "2 minute candlesticks, hour alignment" }{ "value": "M4", "label": "4 minute candlesticks, hour alignment" }{ "value": "M5", "label": "5 minute candlesticks, hour alignment" }{ "value": "M10", "label": "10 minute candlesticks, hour alignment" }{ "value": "M15", "label": "15 minute candlesticks, hour alignment" }{ "value": "M30", "label": "30 minute candlesticks, hour alignment" }{ "value": "H1", "label": "1 hour candlesticks, hour alignment" }{ "value": "H2", "label": "2 hour candlesticks, day alignment" }{ "value": "H3", "label": "3 hour candlesticks, day alignment" }{ "value": "H4", "label": "4 hour candlesticks, day alignment" }{ "value": "H6", "label": "6 hour candlesticks, day alignment" }{ "value": "H8", "label": "8 hour candlesticks, day alignment" }{ "value": "H12", "label": "12 hour candlesticks, day alignment" }{ "value": "D", "label": "1 day candlesticks, day alignment" }{ "value": "W", "label": "1 week candlesticks, aligned to start of week" }{ "value": "M", "label": "1 month candlesticks, aligned to first day of the month" }`
Smooth	`smooth`	`boolean`	A flag that controls whether the candlestick is “smoothed” or not. A smoothed candlestick uses the previous candle’s close price as its open price, while an unsmoothed candlestick uses the first price from its time range as its open price.
Include First	`includeFirst`	`boolean`	A flag that controls whether the candlestick that is covered by the from time should be included in the results. This flag enables clients to use the timestamp of the last completed candlestick received to poll for future candlesticks but avoid receiving the previous candlestick repeatedly.
Daily Alignment	`dailyAlignment`	`integer`	The hour of the day (in the specified timezone) to use for granularities that have daily alignments. minimum=0, maximum=23
Alignment Timezone	`alignmentTimezone`	`string`	The timezone to use for the dailyAlignment parameter. Candlesticks with daily alignment will be aligned to the dailyAlignment hour within the alignmentTimezone. Note that the returned times will still be represented in UTC. [default=America/New_York]
Weekly Alignment	`weeklyAlignment`	`string`	Select a value from the drop down menu:`MondayTuesdayWednesdayThrusdayFridaySaturdaySunday`
Units	`units`	`integer`	The number of units used to calculate the volume-weighted average bid and ask prices in the returned candles. [default=1]