API Reference

This reference is generated from the source docstrings. It focuses on the public classes you use to connect to a device and drive services.

New to the library? Read the Python API guide first — it shows the connect → service pattern with runnable examples. This section is the detailed lookup.

• Connecting to a device — lockdown clients, RemoteServiceDiscovery, tunneld.
• Lockdown services — the LockdownService base class and the most-used services.
• System & device — activation, notifications, power, recovery, companion.
• Apps, files & profiles — house arrest, configuration and provisioning profiles.
• Capture, logging & automation — screenshots, pcap, syslog, WebInspector, WDA.
• Backup, symbols & location — backup/restore, symbol fetching, GPS simulation.
• Developer / DVT — the DVT provider and instruments (iOS 17+, over a tunnel).

Docstring coverage is a work in progress

Some methods are not yet documented. The generated pages reflect the current source; missing prose means the docstring hasn't been written yet, not that the method is private.