API reference
Response schemas
Field definitions derived from the OpenAPI contract.
These are HTTP document shapes, not SDK classes. Codes and expanded objects are both valid representations, controlled by expand.
Prices are JSON numbers in Australian cents per litre; product keys are strings. Timestamps use AWST, postcodes stay strings, and null means unavailable rather than an empty string or zero.
PriceDocument
HTTP PriceDocument schema.
Fields
required
See the linked schema for this field.
Show child fields
"1.1"
requiredSee the linked schema for this field.
required
See the linked schema for this field.
Show child fields
"fuelwatch.wa.gov.au"
requiredSee the linked schema for this field.
string
requiredSelected Perth calendar date.
string
requiredOldest contributing origin fetch; never reset by cache reads.
string
requiredAWST timestamp with explicit +08:00 offset.
string
requiredExclusive end of the price period at 06:00 the next day.
string
requiredNonempty, valid empty, or empty tomorrow selection before 14:30 AWST. Not a separate availability endpoint.
Possible enum values
availableemptynot_yet_publishedoptional
FuelWatch product identifier. There is no product 3. See the product codes for names.
Possible enum values
optional
See the linked schema for this field.
Possible enum values
string
requiredPublisher and API copyright notice.
string
requiredDocumentation URL.
string
requiredIssue tracker URL.
string
requiredWorker package version that rendered this document. Distinct from the /v1 route and JSON:API version; cached documents can retain the previous version.
required
See the linked schema for this field.
Show child fields
"serviceStation"
requiredSee the linked schema for this field.
string
requiredOpaque identity for one station and source date. Stable across selected products, expansion, prices and enrichment, but changes with source date or station identity.
required
See the linked schema for this field.
JsonApi
HTTP JsonApi schema.
Fields
"1.1"
requiredSee the linked schema for this field.
Metadata
HTTP Metadata schema.
Fields
"fuelwatch.wa.gov.au"
requiredSee the linked schema for this field.
string
requiredSelected Perth calendar date.
string
requiredOldest contributing origin fetch; never reset by cache reads.
string
requiredAWST timestamp with explicit +08:00 offset.
string
requiredExclusive end of the price period at 06:00 the next day.
string
requiredNonempty, valid empty, or empty tomorrow selection before 14:30 AWST. Not a separate availability endpoint.
Possible enum values
availableemptynot_yet_publishedoptional
FuelWatch product identifier. There is no product 3. See the product codes for names.
Possible enum values
optional
See the linked schema for this field.
Possible enum values
string
requiredPublisher and API copyright notice.
string
requiredDocumentation URL.
string
requiredIssue tracker URL.
string
requiredWorker package version that rendered this document. Distinct from the /v1 route and JSON:API version; cached documents can retain the previous version.
ServiceStation
HTTP ServiceStation schema.
Fields
"serviceStation"
requiredSee the linked schema for this field.
string
requiredOpaque identity for one station and source date. Stable across selected products, expansion, prices and enrichment, but changes with source date or station identity.
required
See the linked schema for this field.
Show child fields
string
requiredFuelWatch station name.
string
requiredFuelWatch trading name.
required
See the linked schema for this field.
required
See the linked schema for this field.
boolean | null
requiredtrue: known continuous opening; false: known limited schedule; null: unknown.
string | null
requiredValid E.164 phone number, or null.
number
requiredSee the linked schema for this field.
number
requiredSee the linked schema for this field.
required
Codes by default, objects when expanded. Empty is []; each nonempty array uses one representation.
Possible enum values
required
Codes or expanded objects; null when there are no known restrictions.
optional
Optional local AWST weekday schedule. Missing weekdays are unknown. End before start means next day; 24:00 is allowed only as a closing time.
optional
Optional original text that could not be represented by the controlled schema.
optional
Present only when provider fields were used. Preserve attribution when displaying them.
StationAttributes
HTTP StationAttributes schema.
Fields
string
requiredFuelWatch station name.
string
requiredFuelWatch trading name.
Numeric by default; object when brand is expanded.
Possible enum values
Show child fields
required
string
requiredHuman-readable label.
string
requiredRoot-relative SVG URL; resolve against the API origin.
required
See the linked schema for this field.
Show child fields
string
requiredStart of the selected price period at 06:00 AWST; equals meta.validFrom.
object
requiredSelected product IDs as JSON string keys. Missing products are unavailable, never zero. 195.1 cents/L means AUD 1.951/L.
required
See the linked schema for this field.
Show child fields
string
requiredFuelWatch street address.
string
requiredFuelWatch suburb/locality.
"WA"
requiredSee the linked schema for this field.
string | null
requiredAustralian postcode, preserving leading zeroes; null when unavailable.
boolean | null
requiredtrue: known continuous opening; false: known limited schedule; null: unknown.
string | null
requiredValid E.164 phone number, or null.
number
requiredSee the linked schema for this field.
number
requiredSee the linked schema for this field.
required
Codes by default, objects when expanded. Empty is []; each nonempty array uses one representation.
Possible enum values
Show child fields
required
Stable reference code.
Possible enum values
string
requiredHuman-readable label.
required
Codes or expanded objects; null when there are no known restrictions.
Possible enum values
Show child fields
required
Stable reference code.
string
requiredHuman-readable label.
optional
Optional local AWST weekday schedule. Missing weekdays are unknown. End before start means next day; 24:00 is allowed only as a closing time.
Show child fields
string
optionalClosed, or one or more comma-separated HH:mm-HH:mm intervals.
string
optionalClosed, or one or more comma-separated HH:mm-HH:mm intervals.
string
optionalClosed, or one or more comma-separated HH:mm-HH:mm intervals.
string
optionalClosed, or one or more comma-separated HH:mm-HH:mm intervals.
string
optionalClosed, or one or more comma-separated HH:mm-HH:mm intervals.
string
optionalClosed, or one or more comma-separated HH:mm-HH:mm intervals.
string
optionalClosed, or one or more comma-separated HH:mm-HH:mm intervals.
optional
Optional original text that could not be represented by the controlled schema.
Show child fields
string
optionalUnmapped source brand, paired with code 0.
string[]
optionalSee the linked schema for this field.
string[]
optionalSee the linked schema for this field.
string
optionalUnparsed source hours; blocks provider replacement.
string
optionalInvalid or ambiguous source phone; blocks provider replacement.
optional
Present only when provider fields were used. Preserve attribution when displaying them.
Show child fields
"Google Maps"
requiredSee the linked schema for this field.
string
requiredMatched Google place identifier.
string
requiredAWST timestamp with explicit +08:00 offset.
boolean
requiredProvider refresh deadline has passed; data is still within its 30-day retention limit.
string[]
requiredSee the linked schema for this field.
string
requiredGoogle Maps URL for the matched place.
required
See the linked schema for this field.
Price
HTTP Price schema.
Fields
string
requiredStart of the selected price period at 06:00 AWST; equals meta.validFrom.
object
requiredSelected product IDs as JSON string keys. Missing products are unavailable, never zero. 195.1 cents/L means AUD 1.951/L.
Show child fields
number
optionalUnleaded Petrol in Australian cents per litre.
number
optionalPremium Unleaded 95 in Australian cents per litre.
number
optionalDiesel in Australian cents per litre.
number
optionalLPG in Australian cents per litre.
number
optionalPremium Unleaded 98 in Australian cents per litre.
number
optionalE85 in Australian cents per litre.
number
optionalBrand Diesel in Australian cents per litre.
Address
HTTP Address schema.
Fields
string
requiredFuelWatch street address.
string
requiredFuelWatch suburb/locality.
"WA"
requiredSee the linked schema for this field.
string | null
requiredAustralian postcode, preserving leading zeroes; null when unavailable.
BrandCode
FuelWatch brand code. Reserved response-only code 0 means unmapped; sourceNotes.brand retains its name. See the brand codes for names.
Fields
integer
requiredFuelWatch brand code. Reserved response-only code 0 means unmapped; sourceNotes.brand retains its name. See the brand codes for names.
Brand
HTTP Brand schema.
Fields
required
string
requiredHuman-readable label.
string
requiredRoot-relative SVG URL; resolve against the API origin.
ProductCode
FuelWatch product identifier. There is no product 3. See the product codes for names.
Fields
integer
requiredFuelWatch product identifier. There is no product 3. See the product codes for names.
Possible enum values
FeatureCode
Stable API feature identifier; not an array position. See the site feature codes for names.
Fields
integer
requiredStable API feature identifier; not an array position. See the site feature codes for names.
Possible enum values
SiteFeature
HTTP SiteFeature schema.
Fields
required
Stable reference code.
Possible enum values
string
requiredHuman-readable label.
RestrictionCode
Stable API restriction identifier. See the restriction codes for names.
Fields
integer
requiredStable API restriction identifier. See the restriction codes for names.
Restriction
HTTP Restriction schema.
Fields
required
Stable reference code.
string
requiredHuman-readable label.
OpeningHours
Optional local AWST weekday schedule. Missing weekdays are unknown. End before start means next day; 24:00 is allowed only as a closing time.
Fields
string
optionalClosed, or one or more comma-separated HH:mm-HH:mm intervals.
string
optionalClosed, or one or more comma-separated HH:mm-HH:mm intervals.
string
optionalClosed, or one or more comma-separated HH:mm-HH:mm intervals.
string
optionalClosed, or one or more comma-separated HH:mm-HH:mm intervals.
string
optionalClosed, or one or more comma-separated HH:mm-HH:mm intervals.
string
optionalClosed, or one or more comma-separated HH:mm-HH:mm intervals.
string
optionalClosed, or one or more comma-separated HH:mm-HH:mm intervals.
SourceNotes
Optional original text that could not be represented by the controlled schema.
Fields
string
optionalUnmapped source brand, paired with code 0.
string[]
optionalSee the linked schema for this field.
string[]
optionalSee the linked schema for this field.
string
optionalUnparsed source hours; blocks provider replacement.
string
optionalInvalid or ambiguous source phone; blocks provider replacement.
Enrichment
Present only when provider fields were used. Preserve attribution when displaying them.
Fields
"Google Maps"
requiredSee the linked schema for this field.
string
requiredMatched Google place identifier.
string
requiredAWST timestamp with explicit +08:00 offset.
boolean
requiredProvider refresh deadline has passed; data is still within its 30-day retention limit.
string[]
requiredSee the linked schema for this field.
string
requiredGoogle Maps URL for the matched place.
required
See the linked schema for this field.
Show child fields
string
requiredThird-party provider display name.
string
requiredAttribution URL.
Attribution
HTTP Attribution schema.
Fields
string
requiredThird-party provider display name.
string
requiredAttribution URL.
ErrorDocument
HTTP ErrorDocument schema.
Fields
required
See the linked schema for this field.
Show child fields
"1.1"
requiredSee the linked schema for this field.
ApiError[]
requiredSee the linked schema for this field.
Show child fields
string
requiredSee the linked schema for this field.
Possible enum values
400404405406415500502503504string
requiredSee the linked schema for this field.
Possible enum values
invalid_querynot_foundmethod_not_allowednot_acceptableunsupported_media_typeinternal_errorinvalid_feedresponse_too_largeupstream_deniedupstream_unavailablecache_refresh_busyupstream_timeoutstring
requiredSafe diagnostic message; do not branch on its wording.
ApiError
HTTP ApiError schema.
Fields
string
requiredSee the linked schema for this field.
Possible enum values
400404405406415500502503504string
requiredSee the linked schema for this field.
Possible enum values
invalid_querynot_foundmethod_not_allowednot_acceptableunsupported_media_typeinternal_errorinvalid_feedresponse_too_largeupstream_deniedupstream_unavailablecache_refresh_busyupstream_timeoutstring
requiredSafe diagnostic message; do not branch on its wording.
LegacyDocument
HTTP LegacyDocument schema.
Fields
object
requiredRSS channel/parser metadata and validated items. Not a JSON:API document.
Show child fields
required
See the linked schema for this field.
LegacyItem
Validated RSS-shaped station quote. Source/parser members are preserved; quotes are not grouped by station.
Fields
string
requiredSource trading name.
string
optionalSource brand label.
string
requiredPrice in cents/L, as source text.
string
requiredSource price date.
string
requiredStreet address.
string
requiredSuburb.
string
requiredLatitude as source text.
string
requiredLongitude as source text.
string | null
requiredNormalized E.164 phone or null.
string
optionalSource feature/hours text.
string
optionalSource restrictions text.
optional
Included only for multi-product selections.
Possible enum values
LegacyError
HTTP LegacyError schema.
Fields
object
requiredSee the linked schema for this field.
Show child fields
string
requiredSee the linked schema for this field.
Possible enum values
invalid_querynot_foundmethod_not_allowednot_acceptableunsupported_media_typeinternal_errorinvalid_feedresponse_too_largeupstream_deniedupstream_unavailablecache_refresh_busyupstream_timeoutstring
requiredSafe diagnostic message.
Absent versus null
phone,address.postcodeandis24Hoursare always present and can be null.siteFeaturesis always an array, including when empty.restrictionsis null when no known restriction is supplied.openHoursis optional and omitted for confirmed 24-hour opening. Unknown weekdays are omitted.sourceNotesandenrichmentare optional.price.productsomits unavailable products.meta.productappears for one selected fuel;meta.productsappears for multiple selected fuels. They never coexist.- Unknown informational metadata can be added without changing the station resource contract.
meta.version identifies the Worker package that rendered the document. It is separate from the /v1 route and jsonapi.version (the JSON:API document version). A cached response can retain a previous Worker version until it expires.
Enrichment does not introduce RSS title, image, description or schemaVersion fields. See station details and attribution for source precedence.