Skip to main content

Latest version on PyPI Travis CI build status

Get the MAC address of remote hosts or network interfaces using Python.

It provides a platform-independant interface to get the MAC addresses of:

  • System network interfaces (by interface name)
  • Remote hosts (by IPv4/IPv6 address or hostname)

It provides one function: get_mac_address()

Features

  • Pure-Python
  • Supports Python 2.6+, 3.2+, pypy, and pypy3
  • No dependencies
  • Small size
  • Can be used as an independant .py file
  • Simple terminal tool (when installed as a package)

Usage

Python examples

from getmac import get_mac_address
eth_mac = get_mac_address(interface="eth0")
win_mac = get_mac_address(interface="Ethernet 3")
ip_mac = get_mac_address(ip="192.168.0.1")
ip6_mac = get_mac_address(ip6="::1")
host_mac = get_mac_address(hostname="localhost")
updated_mac = get_mac_address(ip="10.0.0.1", network_request=True)

Terminal examples

get-mac --interface 'eth0'
get-mac --ip '192.168.0.1'
get-mac --ip6 '::1'
python -m getmac --interface 'eth0'
python -m getmac --ip '192.168.0.1'
python -m getmac --ip6 '::1'

Note: the terminal interface will not work on Python 2.6 (Sorry CentOS 6 users!).

get_mac_address()

  • interface: Name of a network interface on the system.
  • ip: IPv4 address of a remote host.
  • ip6: IPv6 address of a remote host.
  • hostname: Hostname of a remote host.
  • network_request: If an network request (ping usually) should be made to update and populate the ARP table of remote hosts used to lookup MACs in most circumstances. Disable this if you want to just use what's already in the table, or if you have requirements to prevent network traffic.

Notes

  • The first four arguments are mutually exclusive. network_request does not have any functionality when the interface argument is specified, and can be safely set if using in a script.
  • If none of the arguments are selected, the default network interface for the system will be used.
  • For the time being, it assumes you are using Ethernet.
  • Exceptions will be handled silently and returned as a None. If you run into problems, create an issue on GitHub, or set DEBUG to true if you're brave.
  • Messages are output using the warnings library. If you are using logging, they can be captured using logging.captureWarnings(). Otherwise, they can be suppressed using warnings.filterwarnings("ignore"). https://docs.python.org/3/library/warnings.html

Platforms

  • Windows
    • Versions: 2000, XP, Vista, 7, 8/8.1, 10
    • Commands: ipconfig, ping
    • Libraries: ctypes
  • Linux
    • Distros: Debian, RHEL
    • Commands: arp, ip, ifconfig
    • Libraries: fcntl
  • Mac OS X (Darwin)
    • Same linux/unix
  • HP-UX:
    • lanscan
  • Generic Unix-based
    • Commands: netstat, cat

Caveats & Known issues

Caveats

  • Depending on the platform, there could be a performance detriment, due to heavy usage of regular expressions.
  • Testing is only on a few platforms (Ubuntu 14+, Windows 10, OSX), so your mileage may vary. Please report any problems by opening a issue on GitHub!

Known Issues

  • Hostnames for IPv6 devices are not yet supported.
  • The "default" of selecting the default route interface for the platform currently attempts to use common default interfaces, not the actual default.

Sources

Many of the methods used to acquire an address and the core logic framework are attributed to the CPython project's UUID implementation.

TODO

Full list of tasks and bugs can be found in TODO.md

License

MIT. Feel free to copy, modify, and use to your heart's content. Have fun!

Metadata

Release files for get-mac 0.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for get-mac 0.2.2
File Size Uploaded Provenance Actions
get-mac-0.2.2.tar.gz 8.9 kB Without provenance Details for get-mac-0.2.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for get-mac 0.2.2
File Interpreter ABI Platform Actions
get_mac-0.2.2-py3-none-any.whl Python 3 none any Details for get_mac-0.2.2-py3-none-any.whl

Total release size: 18.7 kB

Release files / get-mac-0.2.2.tar.gz

Download URL get-mac-0.2.2.tar.gz
Size 8.9 kB
Tags Source
SHA-256 checksum
How to use checksums
7a8cdec6c4b0ce671f8f87d9d37b23eae5ebd42f6785f9f70e93cdd39cbdac02
BLAKE2b-256 checksum
How to use checksums
a0a195007f1c52f6be6a917512092304950f24f461bd5dfc31ba95528518e42f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.5

Release files / get_mac-0.2.2-py3-none-any.whl

Download URL get_mac-0.2.2-py3-none-any.whl
Size 9.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
247fb866677cf439d9338e01a9bfff1efa3191fae251fab1e710861e5fc667f9
BLAKE2b-256 checksum
How to use checksums
83f9f6253cc661f9db3a4bcf172f015fd4e29c5b585fc43a493f853228a284c2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.5

Security for get-mac 0.2.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page