Fares

Compare the best saved fares across dates

Returns the latest comparable saved fare evidence across a requested date range, including unavailable dates and freshness metadata.

get/v1/fares/best

Request

  • Base URL: https://sweetsaverfare.com
  • URL: https://sweetsaverfare.com/v1/fares/best
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://sweetsaverfare.com/oauth/auth, token URL https://sweetsaverfare.com/oauth/token, scopes: fares:read)

Query parameters

route_id'TSA_SWB' | 'SWB_TSA' | 'TSA_DUK' | 'DUK_TSA' | 'TSA_NAN' | 'HSB_NAN' | 'NAN_HSB' | 'SWB_FUL' | 'FUL_SWB' | 'HSB_LNG' | 'LNG_HSB' | 'ERL_SLT' | 'SLT_ERL' | 'CMX_PWR' | 'PWR_CMX' required

Supported Sweet Saver Fare route identifier.

profile_id'ADULT_NO_VEHICLE' | 'ADULT_STANDARD_VEHICLE' | 'ADULT_OVERHEIGHT_VEHICLE' required

Traveller and vehicle profile used for comparable fare evidence.

fromstring date required

First travel date to compare, in YYYY-MM-DD format.

tostring date required

Last travel date to compare, in YYYY-MM-DD format.

passenger'ADULT' | 'SENIOR_65_PLUS' | 'CHILD_0_4' | 'CHILD_5_11'

Optional passenger fare rule used for the fare calculation.

Response

Best fares

observation_idstring uuid nullable required
observed_atstring date-time required
stale_afterstring date-time required
freshness_state'fresh' | 'stale' | 'expired' required
source_status'ok' | 'missing' | 'provider_queue_active' | 'session_expired' | 'blocked' | 'unknown' required
data_source'demo' | 'fake_worker' | 'fixture' | 'live_provider' | 'schedule_reference' required
parser_versionstring required
observation_trace_idstring nullable required
fixture_shastring nullable required
observation_outcome'verified' | 'partial' | 'unavailable' | 'failed'
disclaimer'Ferry fares can change. Confirm final availability and price directly with BC Ferries before making travel decisions.' required
route_id'TSA_SWB' | 'SWB_TSA' | 'TSA_DUK' | 'DUK_TSA' | 'TSA_NAN' | 'HSB_NAN' | 'NAN_HSB' | 'SWB_FUL' | 'FUL_SWB' | 'HSB_LNG' | 'LNG_HSB' | 'ERL_SLT' | 'SLT_ERL' | 'CMX_PWR' | 'PWR_CMX' required
profile_id'ADULT_NO_VEHICLE' | 'ADULT_STANDARD_VEHICLE' | 'ADULT_OVERHEIGHT_VEHICLE' required
fromstring date required
tostring date required
booking_closed_datesstring[]
data_unavailable_datesstring[] required
data_unavailable_fromstring date nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.