Predictions

Read qualified Beta predictions

Returns stored qualified Beta fare or vehicle-space predictions when the account is entitled and reliable prediction evidence is available.

get/v1/predictions

Request

  • Base URL: https://sweetsaverfare.com
  • URL: https://sweetsaverfare.com/v1/predictions
  • 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: predictions:read)

Query parameters

sailing_instance_idstring[] required

One or more stored sailing-instance UUIDs, with at most 20 unique IDs.

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

Traveller and vehicle profile used for comparable fare evidence.

target'LOWER_SAVER_24H' | 'LOWER_SAVER_7D' | 'DECREASE_BEFORE_SAILING' | 'VEHICLE_SPACE_AVAILABILITY'

Optional qualified prediction target to return.

Response

Stored beta fare and vehicle prediction

plan'frequent_traveller' | 'connected_traveller' required
disclaimerstring required

Changes

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