Stytch Python Library
The Stytch Python library makes it easy to use the Stytch user infrastructure API in Python applications.
It pairs well with the Stytch Web SDK or your own custom authentication flow.
Requirements
The Stytch Python library supports Python 3.10+
Installation
pip install stytch
Usage
You can find your API credentials in the Stytch Dashboard.
This client library supports all Stytch's live products:
B2C
- Email Magic Links
- Embeddable Magic Links
- OAuth logins
- SMS passcodes
- WhatsApp passcodes
- Email passcodes
- Session Management
- WebAuthn
- Time-based one-time passcodes (TOTPs)
- Crypto wallets
- Passwords
B2B
- Organizations
- Members
- Email Magic Links
- OAuth logins
- Session Management
- Single-Sign On
- Discovery
- Passwords
Example B2C usage
Create an API client:
import stytch
client = stytch.Client(
project_id="project-live-c60c0abe-c25a-4472-a9ed-320c6667d317",
secret="secret-live-80JASucyk7z_G8Z-7dVwZVGXL5NT_qGAQ2I=",
# Optionally specify a custom base URL for all API calls
# custom_base_url="https://api.custom-domain.com/",
)
Send a magic link by email:
login_or_create_resp = client.magic_links.email.login_or_create(
email="sandbox@stytch.com",
login_magic_link_url="https://example.com/authenticate",
signup_magic_link_url="https://example.com/authenticate",
)
# Responses are fully-typed `pydantic` objects
print(login_or_create_resp)
Authenticate the token from the magic link:
auth_resp = client.magic_links.authenticate(
token="DOYoip3rvIMMW5lgItikFK-Ak1CfMsgjuiCyI7uuU94=",
)
print(auth_resp)
Async support
Every endpoint supports an async version which you can use by appending _async to the method name. You can use the
same Client object for sync and async methods. The above example of sending and authenticating an magic link can
be rewritten as:
login_or_create_resp = await client.magic_links.email.login_or_create_async(
email="sandbox@stytch.com",
login_magic_link_url="https://example.com/authenticate",
signup_magic_link_url="https://example.com/authenticate",
)
print(login_or_create_resp)
auth_resp = await client.magic_links.authenticate(
token="DOYoip3rvIMMW5lgItikFK-Ak1CfMsgjuiCyI7uuU94=",
)
print(resp)
Example B2B usage
Create an API client:
Python:
import stytch
client = stytch.B2BClient(
project_id="project-live-c60c0abe-c25a-4472-a9ed-320c6667d317",
secret="secret-live-80JASucyk7z_G8Z-7dVwZVGXL5NT_qGAQ2I=",
# Optionally specify a custom base URL for all API calls
# custom_base_url="https://api.custom-domain.com/",
)
Create an organization
response = client.organizations.create(
organization_name="Acme Co",
organization_slug="acme-co",
email_allowed_domains=["acme.co"]
)
Log the first user into the organization
response = client.magic_links.email.login_or_signup(
organization_id="ORGANIZATION_ID_FROM_RESPONSE",
email_address="admin@acme.co",
login_redirect_url="https://example.com/authenticate",
signup_redirect_url="https://example.com/authenticate"
)
Handling Errors
Structured errors from the Stytch API will raise StytchError exceptions. You can view the details of the error through
the .details property of the StytchError exception.
from stytch.core.response_base import StytchError
try:
auth_resp = await client.magic_links.authenticate_async(token="token")
except StytchError as error:
# Handle Stytch errors here
if error.details.error_type == "invalid_token":
print("Whoops! Try again?")
except Exception as error:
# Handle other errors here
pass
Learn more about errors in the docs.
Documentation
See example requests and responses for all the endpoints in the Stytch API Reference.
Follow one of the integration guides or start with one of our example apps.
Support
If you've found a bug, open an issue!
If you have questions or want help troubleshooting, join us in Slack or email support@stytch.com.
If you've found a security vulnerability, please follow our responsible disclosure instructions.
Development
See DEVELOPMENT.md
Code of Conduct
Everyone interacting in the Stytch project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.
Release files for stytch 15.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| stytch-15.3.0.tar.gz | 182.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| stytch-15.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 492.7 kB
Release files / stytch-15.3.0.tar.gz
| Download URL | stytch-15.3.0.tar.gz |
|---|---|
| Size | 182.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f5e170c0dbb797541f80ef7e4dedcad1ed4585d3afbaa3cd3392dcd2d6245c78
|
|
BLAKE2b-256 checksum How to use checksums |
1adc2cc6554d5ae8e1fd15f1b48342049a614b801fc7c714ac5fb394a3a2f54a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Release files / stytch-15.3.0-py3-none-any.whl
| Download URL | stytch-15.3.0-py3-none-any.whl |
|---|---|
| Size | 310.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6deba2fe298de66481f1c7287021268c556ba328b1c0e5b7de78ac895b62f0b6
|
|
BLAKE2b-256 checksum How to use checksums |
c1692d2ccb125ce97cded25aae0dc20fc003af61f76852ce0557e8030be4d0f3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|