Python wrapper for the Mastodon ( https://github.com/mastodon/mastodon/ ) API. Feature complete for public API as of Mastodon version 4.4.3 and easy to get started with:

from mastodon import Mastodon

# Register your app! This only needs to be done once (per server, or when
# distributing rather than hosting an application, most likely per device and server).
# Uncomment the code and substitute in your information:
'''
Mastodon.create_app(
    'pytooterapp',
    api_base_url = 'https://mastodon.social',
    to_file = 'pytooter_clientcred.secret'
)
'''

# Then, log in. This can be done every time your application starts, or you can use the persisted information:
mastodon = Mastodon(client_id = 'pytooter_clientcred.secret',)
print(mastodon.auth_request_url())

# open the URL in the browser and paste the code you get
mastodon.log_in(
    code=input("Enter the OAuth authorization code: "),
    to_file="pytooter_usercred.secret"
)

# To post, create an actual API instance:
mastodon = Mastodon(access_token = 'pytooter_usercred.secret')
mastodon.toot('Tooting from Python using #mastodonpy !')

You can install Mastodon.py via pypi:

pip install Mastodon.py

We currently try to support Python 3.7 and above, and try to at least not break Python 3 versions below that. Python 2 support is no longer a goal.

Full documentation and basic usage examples can be found at https://mastodonpy.readthedocs.io/en/stable/ . Some more extensive examples can be found at https://github.com/halcy/MastodonpyExamples

If you have any questions about using the library or think you have found a bug, please feel free to open an issue, a github discussion thread, or to just directly contact @halcy@icosahedron.website on the Fediverse or .halcy on Discord - we’ll try to respond as quickly as possible.

Acknowledgements

Mastodon.py contains work by a large amount of contributors, many of which have put significant work into making it a better library. You can find some information about who helped with which particular feature or fix in the changelog.

https://circleci.com/gh/halcy/Mastodon.py.svg?style=svg https://codecov.io/gh/halcy/Mastodon.py/branch/master/graph/badge.svg

Project links

Data verified by PyPI on Sep 1, 2025
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (2.2.2)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for halcy from gravatar.com halcy

Credits

Author: Lorenz Diener

GitHub Statistics

Data verified by PyPI on Sep 1, 2025
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

MIT License (MIT)

Provides Extra

webpush blurhash grapheme test test-old docs

Tags

mastodon api microblogging

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mastodon_py-2.1.3.tar.gz (11.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mastodon_py-2.1.3-py3-none-any.whl (123.3 kB view details)

Uploaded Python 3

File details

Details for the file mastodon_py-2.1.3.tar.gz.

File metadata

  • Download URL: mastodon_py-2.1.3.tar.gz
  • Upload date:
  • Size: 11.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mastodon_py-2.1.3.tar.gz
Algorithm Hash digest
SHA256 7beb61597b7a2083ed02a980836232496fb2fcc724cae305d4f128e4cd6c9d81
MD5 02187559cb9b6839b21c30994f04017f
BLAKE2b-256 c8eebb06d026a2cb49b0a2d750213dac563944010b3a8d971db5aa578d549059

See more details on using hashes here.

Provenance

The following attestation bundles were made for mastodon_py-2.1.3.tar.gz:

Publisher: publish.yml on halcy/Mastodon.py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mastodon_py-2.1.3-py3-none-any.whl.

File metadata

  • Download URL: mastodon_py-2.1.3-py3-none-any.whl
  • Upload date:
  • Size: 123.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mastodon_py-2.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e67571f1f2d8db12f08dfcf9b3c93aa70325092d5f3d4d6711f67aa540f60452
MD5 5d439761b2bc53aead1b9fe628eec5c7
BLAKE2b-256 d1ca3b0514662d84705319be2beca95498d8ad56d6a10b0ffaf9858fba7ecc39

See more details on using hashes here.

Provenance

The following attestation bundles were made for mastodon_py-2.1.3-py3-none-any.whl:

Publisher: publish.yml on halcy/Mastodon.py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

2.2.2

2 files

2.2.1

2 files

2.2.0

2 files

2.1.4

2 files

This release

2.1.3 This release

2 files

2.1.2

2 files

2.1.1

2 files

2.1.0

2 files

2.0.1

2 files

2.0.0

2 files

1.8.1

2 files

1.8.0

2 files

1.7.0

2 files

1.6.3

2 files

1.6.2

2 files

1.6.1

2 files

Yanked

1.6.0

2 files

Yanked reason: broken, please install 1.6.1. instead

1.5.2

2 files

1.5.1

2 files

1.5.0

2 files

1.4.6

2 files

1.4.5

2 files

1.4.3

2 files

1.4.2

2 files

1.4.1

2 files

1.4.0

2 files

1.3.1

2 files

1.3.0

2 files

1.2.2

2 files

1.2.1

2 files

1.2.0

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

1.0.8

2 files

1.0.7

2 files

1.0.6

2 files

1.0.5

2 files

1.0.4

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

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