Repository navigation
Watch ExchangeRate
Polls the exchange rate between two currencies on an interval, until it crosses a specified threshold.
Watch-ExchangeRate [[-From] <String>] [[-To] <String>] [-AboveThreshold <Decimal>] [-BelowThreshold <Decimal>]
[-IntervalSeconds <Int32>] [-MaxIterations <Int32>] [-APIKey <String>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Repeatedly calls Get-ExchangeRate (or Get-CryptoExchangeRate, if -From or -To is a crypto currency) on the interval specified by -IntervalSeconds, writing a result to the pipeline for each poll. If -AboveThreshold or -BelowThreshold is specified, polling stops as soon as the rate crosses that threshold (the result for that poll has its Triggered property set to $true). If neither is specified, polling continues until -MaxIterations is reached, or indefinitely if -MaxIterations isn't specified (use Ctrl+C to stop).
Watch-ExchangeRate -From USD -To GBP -AboveThreshold 0.80 -IntervalSeconds 300
Polls the USD to GBP exchange rate every 5 minutes until it rises to 0.80 or above.
Watch-ExchangeRate -From USD -To GBP -MaxIterations 5
Polls the USD to GBP exchange rate every 60 seconds, 5 times, regardless of its value.
Set-CurrencyDefault -From USD -To GBP
Watch-ExchangeRate -BelowThreshold 0.75
Uses the saved default -From/-To currencies to poll the exchange rate every 60 seconds until it falls to 0.75 or below.
Watch-ExchangeRate -From BTC -To USD -AboveThreshold 100000 -IntervalSeconds 30
Polls the BTC to USD exchange rate every 30 seconds, via Get-CryptoExchangeRate, until it rises to 100000 or above.
The currency to convert from. (Alias: Currency) Defaults to the value saved with Set-CurrencyDefault -From, if any.
Type: String
Parameter Sets: (All)
Aliases: Currency
Required: False
Position: 1
Default value: (Get-CurrencyDefaultValue -Name 'From')
Accept pipeline input: False
Accept wildcard characters: FalseThe currency to convert to. Defaults to the value saved with Set-CurrencyDefault -To, if any. If -From or -To is a crypto currency, the rate is polled via Get-CryptoExchangeRate instead of Get-ExchangeRate (in which case -APIKey is not used).
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: (Get-CurrencyDefaultValue -Name 'To')
Accept pipeline input: False
Accept wildcard characters: FalseOptional: Stop polling once the exchange rate is greater than or equal to this value.
Type: Decimal
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: FalseOptional: Stop polling once the exchange rate is less than or equal to this value.
Type: Decimal
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: FalseHow many seconds to wait between each poll. Defaults to 60.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 60
Accept pipeline input: False
Accept wildcard characters: FalseOptional: The maximum number of times to poll the exchange rate before stopping. If not specified, polling continues indefinitely (or until a specified threshold is crossed).
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: FalseOptional: To use the v6 API, provide your API key, as provided by https://www.exchangerate-api.com/ Defaults to the value saved with Set-CurrencyDefault -APIKey, if any.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: (Get-CurrencyDefaultValue -Name 'APIKey')
Accept pipeline input: False
Accept wildcard characters: False{{Fill ProgressAction Description}}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
https://github.com/markwragg/PowerShell-CurrencyConverter/wiki/Watch-ExchangeRate