Skip to main content

LoginLlama Python SDK for detecting suspicious logins

Project description

LoginLlama API Client

This Python module provides an interface to interact with the LoginLlama API, which offers login status checks for users based on various parameters.

Sign up for free at


Install via pip. Requires Python 3.6 or higher.

pip install


First, import the necessary classes:

from loginllama.loginllama import LoginLlama


To initialize the LoginLlama class, you can either provide an API token directly or set it in the environment variable LOGINLLAMA_API_KEY.

loginllama = LoginLlama("YOUR_API_TOKEN")

Or, if using the environment variable LOGINLLAMA_API_KEY:

loginllama = LoginLlama()
# Pulls from the environment variable LOGINLLAMA_API_KEY

Checking Login Status

The primary function provided by this module is check_login, which checks the login status of a user based on various parameters.


  • request (optional): A Django or Flask request object. If provided, the IP address and user agent will be extracted from this object.
  • ip_address (optional): The IP address of the user. If not provided and the request object is given, it will be extracted from the request.
  • user_agent (optional): The user agent string of the user. If not provided and the request object is given, it will be extracted from the request.
  • identity_key: The unique identity key for the user. This is a required parameter.

Return Value:

The function returns a LoginCheck object. This object contains the result of the login check, including the status, a message, and any applicable codes indicating the reason for the status.


Using IP address and user agent directly:

loginCheckResult = loginllama.check_login(
print(loginCheckResult.status, loginCheckResult.message,

Using a Flask request object:

from flask import Flask, request

app = Flask(__name__)
loginllama = LoginLlama(api_token='your_api_token')

@app.route('/login_check', methods=['POST'])
def login_check():
    identity_key = request.form.get('identity_key')
    if not identity_key:
        return "identity_key is required", 400

        login_check_result = loginllama.check_login(request=request, identity_key=identity_key)
        return {
            "status": login_check_result.status,
            "message": login_check_result.message,
            "codes": [code.value for code in]
    except ValueError as e:
        return str(e), 400
    except Exception as e:
        return str(e), 500

if __name__ == '__main__':

Using a Django request object:

from django.http import JsonResponse
from django.views.decorators.csrf import csrf_exempt
from loginllama.loginllama import LoginLlama

def login_check(request):
    if request.method == 'POST':
        identity_key = request.POST.get('identity_key')
        if not identity_key:
            return JsonResponse({"error": "identity_key is required"}, status=400)

            loginllama = LoginLlama(api_token='your_api_token')
            login_check_result = loginllama.check_login(request=request, identity_key=identity_key)
            return JsonResponse({
                "status": login_check_result.status,
                "message": login_check_result.message,
                "codes": [code.value for code in]
        except ValueError as e:
            return JsonResponse({"error": str(e)}, status=400)
        except Exception as e:
            return JsonResponse({"error": str(e)}, status=500)

    return JsonResponse({"error": "Invalid request method"}, status=405)

Error Handling

The check_login function will raise exceptions if any of the required parameters (ip_address, user_agent, or identity_key) are missing (if request is not provided).

API Endpoint

The default API endpoint used by this module is

Login Status Codes

The module provides an enumeration LoginCheckStatus that lists various possible status codes returned by the LoginLlama API, such as VALID, IP_ADDRESS_SUSPICIOUS, KNOWN_BOT, etc.


If you find any issues or have suggestions for improvements, please open an issue or submit a pull request. Your contributions are welcome!


This module is licensed under the MIT License.

Project details

Release history Release notifications | RSS feed

This version


Download files

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

Source Distribution

loginllama-0.1.tar.gz (16.7 kB view hashes)

Uploaded Source

Built Distribution

loginllama-0.1-py3-none-any.whl (17.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page