About this project

ThreatExchange began as code supporting Meta's ThreatExchange API and has expanded into a collection of projects for signal exchange and content moderation. Main components: - PDQ image hashing: converts photos into 256-bit signatures used to match other photos. - TMK+PDQF (TMK) video hashing: produces 256KB video signatures for similarity matching. - Video PDQ (vPDQ): a simpler video hashing approach that decides whether two videos match based on the number of shared similar frames; it can be applied with image algorithms beyond PDQ. - Hasher-Matcher-Actioner (HMA): a ready-to-deploy content moderation platform for AWS with multiple submodules. It maintains lists of known content to scan for, which can be curated locally or connected to other hash exchange programs to share and receive lists. A second version, Open Media Match, is under construction with a cloud-agnostic Docker-based deployment. - python-threatexchange: a library and CLI published on PyPI as `threatexchange`, offering reference implementations for downloading hashes from Meta's ThreatExchange API, scanning images with PDQ, and more. It is designed to be extended to other hash exchanges and techniques, including ones not written by the maintainers. - api-reference-examples: example implementations in various languages for using the API, at varying levels of completeness. The repository also documents Meta's ThreatExchange API itself: RESTful APIs on the Facebook Platform for querying, publishing, and sharing security threat information such as malware and phishing pages, either with specific community members or the wider community. For tag-driven workloads with bulk download or incremental updates, a Java reference design is recommended. Access requires an application through Meta's developer site, and full documentation, UI, data formats and best practices live in the ThreatExchange docs. Contributions are welcome under the project's contributing guide and code of conduct. All projects are BSD licensed, with noted exceptions for demonstration files (e.g. pdq/cpp/CImg.h).