FindMy.py

Star History

The all-in-one library that provides everything you need to query Apple's FindMy network!

The current "Find My-scene" is quite fragmented, with code being all over the place across multiple repositories, written by several authors. This project aims to unify this scene, providing common building blocks for any application wishing to integrate with the Find My network.

[!IMPORTANT] This project is currently in Alpha. While existing functionality will likely not change much, the API design is subject to change without prior warning.

You are encouraged to report any issues you can find on the issue tracker!

Features

• Cross-platform: no Mac needed
• Fetch and decrypt location reports
  • Official accessories (AirTags, iDevices, etc.)
  • Custom AirTags (OpenHaystack)
• Apple account sign-in
  • SMS 2FA support
  • Trusted Device 2FA support
• Scan for nearby FindMy-devices
  • Decode their info, such as public keys and status bytes
• Import or create your own accessory keys
• Both async and sync APIs

Roadmap

• Local anisette generation (without server)
  • More information: #2

Installation

The package can be installed from PyPi:

pip install findmy

For usage examples, see the examples directory. Documentation can be found here.

Contributing

Want to contribute code? That's great! For new features, please open an issue first so we can discuss.

This project uses Ruff for linting and formatting. Before opening a pull request, please ensure that your code adheres to these rules. There are pre-commit hooks included to help you with this, which you can set up as follows:

pip install poetry
poetry install --with dev  # this installs pre-commit into your environment
pre-commit install

After following the above steps, your code will be linted and formatted automatically before committing it.

Derivative projects

There are several other cool projects based on this library! Some of them have been listed below, make sure to check them out as well.

• OfflineFindRecovery - Set of scripts to be able to precisely locate your lost MacBook via Apple's Offline Find through Bluetooth Low Energy.
• SwiftFindMy - Swift port of FindMy.py

Credits

While I designed the library, the vast majority of actual functionality is made possible by the following wonderful people and organizations:

• @seemo-lab for OpenHaystack and their research;
• @JJTech0130 for Pypush, providing the breakthrough necessary for getting this to work without a Mac;
• @biemster for FindMy, which is the main basis of this project;
• @Dadoum for pyprovision and anisette-v3-server;
• @nythepegasus for GrandSlam SMS 2FA;
• And probably more, so let me know! :D