resolve_xerberus_api_email

Documentation for eth_defi.xerberus.constants.resolve_xerberus_api_email function.

resolve_xerberus_api_email()

Resolve the registered email for Xerberus API auth from the environment.

Xerberus requires the email registered with the API key on every authenticated request (x-user-email header). This helper only reads XERBERUS_API_EMAIL.

It does not invent, default, or derive an email from git config, hostname, or other heuristics. Callers and agents must not guess the value: if this returns None, the operator must set the env var or pass api_email= explicitly into create_xerberus_session().

See README-xerberus.md (Authentication section).

Returns

Email string from XERBERUS_API_EMAIL, or None if unset.

Return type

Optional[str]