Contains API representation for the MySkoda REST API.

RestApi

API hub class that can perform all calls to the MySkoda API.

flash(vin, positions) async

Emit flash.

get_air_conditioning(vin, anonymize=False) async

Retrieve the current air conditioning status for the specified vehicle.

get_auxiliary_heating(vin, anonymize=False) async

Retrieve the current auxiliary heating status for the specified vehicle.

get_charging(vin, anonymize=False) async

Retrieve information related to charging for the specified vehicle.

get_charging_history(vin, cursor=None, start=None, end=None, limit=50) async

Retrieve charging history information for the specified vehicle.

get_charging_profiles(vin, anonymize=False) async

Retrieve information related to chargingprofiles for the specified vehicle.

get_charging_statistics(vin, start, end) async

Retrieve charging session statistics for the specified vehicle via the cariad endpoint.

Replaces the legacy GET /v1/charging/{vin}/history endpoint which stopped returning new sessions after a certain date.

get_departure_timers(vin, anonymize=False) async

Retrieve departure timers for the vehicle.

get_driving_range(vin, anonymize=False) async

Retrieve estimated driving range for combustion vehicles.

get_driving_score(vin, anonymize=False) async

Retrieve driving score for the specified vehicle.

get_garage(anonymize=False) async

Fetch the garage (list of vehicles with limited info).

get_health(vin, anonymize=False) async

Retrieve health information for the specified vehicle.

get_info(vin, anonymize=False) async

Retrieve information related to basic information for the specified vehicle.

get_loyalty_program_badge(user_id, badge_id, anonymize=False) async

Retrieve loyalty program member badge information for the specified badge.

get_loyalty_program_badges(user_id, anonymize=False) async

Retrieve loyalty program badges information for the specified user.

get_loyalty_program_challenges(user_id, anonymize=False) async

Retrieve loyalty program challenges information for the specified user.

get_loyalty_program_details(anonymize=False) async

Retrieve loyalty program details for the specified user.

get_loyalty_program_games(user_id, anonymize=False) async

Retrieve loyalty program games information for the specified user.

get_loyalty_program_member(user_id, anonymize=False) async

Retrieve loyalty program member information for the specified user.

get_loyalty_program_rewards(user_id, anonymize=False) async

Retrieve loyalty program rewards information for the specified user.

get_loyalty_program_salesforce_contacts(user_id, anonymize=False) async

Retrieve Salesforce contact information for the specified user.

get_loyalty_program_transactions(user_id, anonymize=False) async

Retrieve loyalty program transactions information for the specified user.

get_maintenance(vin, anonymize=False) async

Retrieve maintenance report, settings and history.

get_maintenance_report(vin, anonymize=False) async

Retrieve just the maintenance report.

get_parking_position(vin, anonymize=False) async

Retrieve the last known parking position for the specified vehicle.

get_positions(vin, anonymize=False) async

Retrieve the current position for the specified vehicle.

get_single_trip_statistics(vin, start=None, end=None, anonymize=False) async

Retrieve detailed statistics about past trips.

If you want to filter by date, provide both start and end date.

get_software_update_status(vin, anonymize=False) async

Retrieve software update status.

get_status(vin, anonymize=False) async

Retrieve the current status for the specified vehicle.

get_trip_statistics(vin, anonymize=False, offset=0, offset_type=OffsetType.WEEK) async

Retrieve statistics about past trips.

Parameters:
  • vin (str) –

    vehicle VIN

  • offset_type (OffsetType, default: WEEK ) –

    Type of period — WEEK or MONTH.

  • offset (int, default: 0 ) –

    Which period to fetch. 0 = most recent, 1 = one period back, 2 = two periods back, etc.

  • anonymize (bool, default: False ) –

    set to true if personal information should be removed from result

get_user(anonymize=False) async

Retrieve user information about logged in user.

get_vehicle_connection_status(vin, anonymize=False) async

Retrieve vehicle connection status.

get_vehicle_equipment(vin, anonymize=False) async

Retrieve vehicle equipment information for the specified vehicle.

get_vehicle_info(vin, anonymize=False) async

Retrieve vehicle info for the specified vehicle.

get_vehicle_renders(vin, anonymize=False) async

Retrieve vehicle renders for the specified vehicle.

get_widget(vin, anonymize=False) async

Retrieve widget information for the specified vehicle.

honk_flash(vin, positions) async

Emit Honk and flash.

lock(vin, spin) async

Lock the vehicle.

process_json(data, anonymize, anonymization_fn)

Process the raw json returned by the API with some preprocessor logic.

raw_request(url, method, json=None) async

Send an authenticated request to the given API path.

register_fcm_token(fcm_token) async

Register an FCM (Firebase Cloud Messaging) token with the notification backend.

This enables authentication with the MQTT Broker.

set_ac_at_unlock(vin, settings) async

Enable or disable AC at unlock.

set_ac_timer(vin, timer) async

Set air-conditioning timer.

set_ac_without_external_power(vin, settings) async

Enable or disable AC without external power.

set_auto_unlock_plug(vin, enabled) async

Enable or disable auto unlock plug when charged.

set_auxiliary_heating_timer(vin, timer, spin) async

Set auxiliary heating timer.

set_battery_care_mode(vin, enabled) async

Enable or disable the battery care mode.

set_charge_limit(vin, limit) async

Set the maximum charge limit in percent.

set_charge_mode(vin, mode) async

Wake the vehicle up. Can be called maximum three times a day.

set_departure_timer(vin, timer) async

Set departure timer.

set_minimum_charge_limit(vin, limit) async

Set minimum battery SoC in percent for departure timer.

set_reduced_current_limit(vin, reduced) async

Enable reducing the current limit by which the car is charged.

set_seats_heating(vin, settings) async

Enable or disable seats heating with AC.

set_target_temperature(vin, temperature) async

Set the air conditioning's target temperature in °C.

set_windows_heating(vin, settings) async

Enable or disable windows heating with AC.

start_air_conditioning(vin, temperature) async

Start the air conditioning.

start_auxiliary_heating(vin, spin, config=None) async

Start the auxiliary heating.

start_charging(vin) async

Start charging the car.

start_ventilation(vin) async

Start the ventilation.

start_window_heating(vin) async

Start heating both the front and rear window.

stop_air_conditioning(vin) async

Stop the air conditioning.

stop_auxiliary_heating(vin) async

Stop the auxiliary heating.

stop_charging(vin) async

Stop charging the car.

stop_ventilation(vin) async

Start the ventilation.

stop_window_heating(vin) async

Stop heating both the front and rear window.

unlock(vin, spin) async

Unlock the vehicle.

verify_spin(spin, anonymize=False) async

Verify SPIN.

wakeup(vin) async

Wake the vehicle up. Can be called maximum three times a day.