Market Plans API (1.0)

Download OpenAPI specification:Download

Full market plans, current and legacy (from 1st October 2021) for

GraphQL available at https://marketplans.accurassi.com/graphql.

Authentication

BasicAuth

Security Scheme Type: HTTP

HTTP Authorization Scheme: basic

/plans

Authorizations:

BasicAuth

query Parameters

effectiveOnOrAfter	string Find plans that were effective on or after YYYY-MM-DD
expiredOnOrBefore	string Find plans that expired on or before YYYY-MM-DD
planId	string '\|' delimited string of planIDs
postcode	string '\|' delimited string of postcodes
retailerName	string '\|' delimited string of retailer names
fuelType	string '\|' delimited string of fuel types (E\|G\|D)
customerType	string '\|' delimited string of customer types (R\|S)
distributors	string '\|' delimited string of distributors
planType	string '\|' delimited string of plan types (S\|M\|R)
tariffType	string '\|' delimited string of tariff types (SR\|SRCL\|TOU\|TOUCL)
firstSeenOnOrAfter	string Find plans that were first seen on or after YYYY-MM-DD
firstSeenOnOrBefore	string Find plans that were first seen on or before YYYY-MM-DD
lastSeenOnOrAfter	string Find plans that were last seen on or after YYYY-MM-DD
lastSeenOnOrBefore	string Find plans that were first seen on or after YYYY-MM-DD
authorization	string Basic Auth string to authorize API call. Useful when using GraphiQL when setting headers is difficult.

Responses

Request samples

Python
NodeJS
cURL

import requests
url = "https://marketplans.accurassi.com/plans"
payload = "" headers = {
  'Authorization': 'Basic <Base64 Encoded username:password>'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)

Response samples

Content type

application/json

["string"
]

/plans/{planId}

Authorizations:

BasicAuth

path Parameters

planId

required

string

The plan ID

query Parameters

verbose

boolean

true to enable verbose mode. Verbose mode updates each acronym to a text description

Responses

Request samples

Python
NodeJS
cURL

import requests
url = "https://marketplans.accurassi.com/plans/<planId>?verbose=true"
payload = "" headers = {
  'Authorization': 'Basic <Base64 Encoded username:password>'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)

Response samples

Content type

application/json

{"planId": "string",
"planType": "string",
"tariffType": "string",
"electricity": {"pricingModel": "string",
"benfitPeriod": "string",
"coolingOffDays": 0,
"solarFit": [{"type": "string",
"description": "string",
"rate": 0
}
],
"additionalFeeInformation": "string",
"fees": [{"description": "string",
"amount": 0,
"feeType": "string",
"feeTerm": "string",
"percent": 0
}
],
"termType": "string",
"discounts": [{"name": "string",
"description": "string",
"discountPercent": 0,
"type": "string",
"category": "string",
"method": "string",
"discountAmount": 0
}
],
"tariffPeriods": [{"blockName": "string",
"blockDescription": "string",
"startDate": "string",
"endDate": "string",
"blockRate": {"unitPrice": 0,
"volume": 0
},
"blockPeriod": "string",
"dailySupplyCharge": 0,
"touBlock": {"name": "string",
"description": "string",
"blockRate": {"unitPrice": 0,
"volume": 0
},
"timeOfUsePeriod": "string",
"timeOfUse": {"days": "string",
"startTime": "string",
"endTime": "string"
}
},
"demandCharge": {"name": "string",
"description": "string",
"rate": 0,
"startTime": "string",
"endTime": "string"
},
"name": "string",
"blockRateGeneralUnitPrice": "string"
}
],
"variation": "string",
"onExpiry": "string",
"terms": "string",
"billFrequency": [{"number": 0,
"period": "string"
}
],
"meterTypes": ["string"
],
"paymentOptions": ["string"
],
"ifFixed": true,
"controlledLoads": [{"name": "string",
"description": "string",
"blockRate": {"unitPrice": 0,
"volume": 0
},
"dailyCharge": 0,
"blockPeriod": "string"
}
],
"incentives": [{"name": "string",
"description": "string"
}
],
"timeDefinition": "string",
"elegibilityRestrictions": [{"type": "string",
"description": "string",
"information": "string"
}
],
"greenCharges": [{"name": "string",
"chargeType": "string",
"description": "string",
"options": [{"percentage": 0,
"chargeAmount": 0,
"chargePercentage": 0
}
]
}
]
},
"gas": {"pricingModel": "string",
"benfitPeriod": "string",
"coolingOffDays": 0,
"solarFit": [{"type": "string",
"description": "string",
"rate": 0
}
],
"additionalFeeInformation": "string",
"fees": [{"description": "string",
"amount": 0,
"feeType": "string",
"feeTerm": "string",
"percent": 0
}
],
"termType": "string",
"discounts": [{"name": "string",
"description": "string",
"discountPercent": 0,
"type": "string",
"category": "string",
"method": "string",
"discountAmount": 0
}
],
"tariffPeriods": [{"blockName": "string",
"blockDescription": "string",
"startDate": "string",
"endDate": "string",
"blockRate": {"unitPrice": 0,
"volume": 0
},
"blockPeriod": "string",
"dailySupplyCharge": 0,
"touBlock": {"name": "string",
"description": "string",
"blockRate": {"unitPrice": 0,
"volume": 0
},
"timeOfUsePeriod": "string",
"timeOfUse": {"days": "string",
"startTime": "string",
"endTime": "string"
}
},
"demandCharge": {"name": "string",
"description": "string",
"rate": 0,
"startTime": "string",
"endTime": "string"
},
"name": "string",
"blockRateGeneralUnitPrice": "string"
}
],
"variation": "string",
"onExpiry": "string",
"terms": "string",
"billFrequency": [{"number": 0,
"period": "string"
}
],
"meterTypes": ["string"
],
"paymentOptions": ["string"
],
"ifFixed": true,
"controlledLoads": [{"name": "string",
"description": "string",
"blockRate": {"unitPrice": 0,
"volume": 0
},
"dailyCharge": 0,
"blockPeriod": "string"
}
],
"incentives": [{"name": "string",
"description": "string"
}
],
"timeDefinition": "string",
"elegibilityRestrictions": [{"type": "string",
"description": "string",
"information": "string"
}
],
"greenCharges": [{"name": "string",
"chargeType": "string",
"description": "string",
"options": [{"percentage": 0,
"chargeAmount": 0,
"chargePercentage": 0
}
]
}
]
},
"planName": "string",
"supplyAreas": [{"name": "string",
"id": 0
}
],
"distributors": ["string"
],
"genAvailable": true,
"customerType": "string",
"fuelType": "string",
"states": ["string"
],
"effectiveDate": "string",
"expiryDate": "string",
"retailer": {"code": "string",
"id": "string",
"name": "string"
},
"firstSeen": "string",
"lastSeen": "string",
"includedPostcodes": ["string"
],
"excludedPostcodes": ["string"
],
"planInformationDocument": "string",
"meteringCosts": [{"name": "string",
"description": "string",
"period": "string",
"min": 0,
"max": 0
}
]
}