Skip to content

Latest commit

 

History

History
273 lines (215 loc) · 5.56 KB

Get-TibberPriceInfo.md

File metadata and controls

273 lines (215 loc) · 5.56 KB
Raw

Get-TibberPriceInfo

SYNOPSIS

Get the price info for visible home(s).

SYNTAX

__AllParameterSets (Default)

Get-TibberPriceInfo [-ExcludeCurrent] [-ExcludePast] [-IncludeToday] [-IncludeTomorrow] [-Last <Int32>]
 [-Resolution <String>] [-Fields <String[]>] [-PersonalAccessToken <String>] [-UserAgent <String>] [-Force]
 [-DebugResponse] [<CommonParameters>]

HomeId

Get-TibberPriceInfo -HomeId <String> [-ExcludeCurrent] [-ExcludePast] [-IncludeToday] [-IncludeTomorrow]
 [-Last <Int32>] [-Resolution <String>] [-Fields <String[]>] [-PersonalAccessToken <String>]
 [-UserAgent <String>] [-Force] [-DebugResponse] [<CommonParameters>]

URI

Get-TibberPriceInfo [-ExcludeCurrent] [-ExcludePast] [-IncludeToday] [-IncludeTomorrow] [-Last <Int32>]
 [-Resolution <String>] [-Fields <String[]>] [-URI <Uri>] [-PersonalAccessToken <String>] [-UserAgent <String>]
 [-Force] [-DebugResponse] [<CommonParameters>]

DESCRIPTION

Calling this function will return the price info for visible home(s).

EXAMPLES

EXAMPLE 1

$response = Get-TibberPriceInfo -Last 10
$maxPrice = $response | Sort-Object -Property total -Descending | Select-Object -First 1
Write-Host "Max energy price, $($maxPrice.total) $($maxPrice.currency), starting at $(([DateTime]$maxPrice.startsAt).ToString('yyyy-MM-dd HH:mm')) [$($maxPrice.level)]"

EXAMPLE 2

$response = Get-TibberPriceInfo -IncludeToday
Write-Host "Today's energy prices: $($response | Out-String)"

EXAMPLE 3

$response = Get-TibberPriceInfo -IncludeTomorrow
Write-Host "Tomorrow's energy prices: $($response | Out-String)"

PARAMETERS

-HomeId

Specifies the home Id, e.g. '96a14971-525a-4420-aae9-e5aedaa129ff'.

Type: String
Parameter Sets: HomeId
Aliases: Id

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ExcludeCurrent

Switch to exclude current energy price from the results.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ExcludePast

Switch to exclude past energy prices from the results.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IncludeToday

Switch to include today's energy price in the results.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IncludeTomorrow

Switch to include tomorrow's energy price in the results, available after 13:00 CET/CEST.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Last

Specifies the number of nodes to include in results, counting back from the latest entry.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Resolution

Specifies the resoluton of the results (applicable only when '-Last' is provided).

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: HOURLY
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Fields

Specifies the fields to return. https://developer.tibber.com/docs/reference#price

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: @(
            'total'
            'energy'
            'tax'
            'startsAt'
            'currency'
            'level'
        )
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-DebugResponse

{{ Fill DebugResponse Description }}

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Force

{{ Fill Force Description }}

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PersonalAccessToken

{{ Fill PersonalAccessToken Description }}

Type: String
Parameter Sets: (All)
Aliases: PAT, AccessToken, Token

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-URI

{{ Fill URI Description }}

Type: Uri
Parameter Sets: URI
Aliases: URL

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UserAgent

{{ Fill UserAgent Description }}

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

RELATED LINKS

Invoke-TibberQuery

https://developer.tibber.com/docs/reference#priceinfo