PyLibreLinkUp

https://pylibrelinkup.readthedocs.io/en/latest/
Admin
PyLibreLinkUp is a Python client library for the LibreLinkUp API, enabling developers to retrieve...
Tokens:27,758
Snippets:378
Trust Score:9.6
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install from source

Source: https://pylibrelinkup.readthedocs.io/en/latest/_sources/install.rst.txt

Clone the source repository from GitHub and install using pip.

```bash
git clone http://github.com/robberwick/pylibrelinkup.git
cd pylibrelinkup
pip install .
```

--------------------------------

### Install all dependencies

Source: https://pylibrelinkup.readthedocs.io/en/latest/_sources/development.rst.txt

Combines the installation of development, testing, and documentation dependencies.

```bash
pip install -e .[dev,test,docs]
```

--------------------------------

### Install with pip

Source: https://pylibrelinkup.readthedocs.io/en/latest/_sources/install.rst.txt

Install the PyLibreLinkUp package using pip.

```bash
pip install pylibrelinkup
```

--------------------------------

### Install all development dependencies

Source: https://pylibrelinkup.readthedocs.io/en/latest/development.html

Combines the installation of development, testing, and documentation dependencies.

```bash
pip install -e .[dev,test,docs]

```

--------------------------------

### Install from source

Source: https://pylibrelinkup.readthedocs.io/en/latest/_sources/development.rst.txt

Installs the package in editable mode from the pyproject.toml file.

```bash
pip install -e .
```

--------------------------------

### Install additional development dependencies

Source: https://pylibrelinkup.readthedocs.io/en/latest/_sources/development.rst.txt

Installs extra dependencies for development, testing, or documentation.

```bash
pip install -e .[dev]
pip install -e .[test]
pip install -e .[docs]
```

--------------------------------

### PyLibreLinkUp Usage Example

Source: https://pylibrelinkup.readthedocs.io/en/latest/_sources/usage.rst.txt

This code snippet demonstrates how to import the PyLibreLinkUp class, create a client, authenticate, retrieve a list of patients, and fetch the latest data, graph data, and logbook data for a specific patient.

```python
# import the PyLibreLinkUp class
from pylibrelinkup import PyLibreLinkUp

# create a new PyLibreLinkUp client
client = PyLibreLinkUp(email='your_username', password='your_password')

# authenticate the client
client.authenticate()

# get a list of patients
patient_list = client.get_patients()
print(patient_list)

# get the first patient in the list
patient = patient_list[0]

# get the latest data for the patient
print(f"latest: {client.latest(patient_identifier=patient)}")

# get the graph and logbook data for that patient
graph_data = client.graph(patient_identifier=patient)
print(f"graph data ({len(graph_data)} measurements):")
for measurement in graph_data:
    print(f"{measurement.value} {measurement.timestamp} {measurement.factory_timestamp}")

# get the logbook data for the patient
logbook_data = client.logbook(patient_identifier=patient)
print(f"logbook data: ({len(logbook_data)} entries)")
for measurement in logbook_data:
    print(f"{measurement.value} {measurement.timestamp} {measurement.factory_timestamp}")
```

--------------------------------

### Run local unit tests

Source: https://pylibrelinkup.readthedocs.io/en/latest/_sources/development.rst.txt

Executes the local unit tests for the project.

```bash
pytest
```

--------------------------------

### pylibrelinkup.models.login Source Code

Source: https://pylibrelinkup.readthedocs.io/en/latest/_modules/pylibrelinkup/models/login.html

The complete source code for the pylibrelinkup.models.login module, defining various data models.

```python
from typing import List

from pydantic import Field

from .base import ConfigBaseModel

__all__ = [
    "Llu",
    "Consents",
    "SystemMessages",
    "System",
    "User",
    "Notifications",
    "DataMessages",
    "AuthTicket",
    "Data",
    "LoginResponse",
    "ErrorMessage",
    "LoginResponseUnauthenticated",
    "LoginRedirectData",
    "LoginRedirectResponse",
    "LoginArgs",
]




[docs]
class Llu(ConfigBaseModel):
    policyAccept: int = Field(default=0)
    touAccept: int = Field(default=0)




class HistoryItem(ConfigBaseModel):
    policyAccept: int = Field(default=0)
    declined: bool | None = None


class RealWorldEvidence(ConfigBaseModel):
    policyAccept: int = Field(default=0)
    declined: bool = False
    touAccept: int = Field(default=0)
    history: List[HistoryItem] = []




[docs]
class Consents(ConfigBaseModel):
    llu: Llu = Llu()
    realWorldEvidence: RealWorldEvidence = RealWorldEvidence()





[docs]
class SystemMessages(ConfigBaseModel):
    firstUsePhoenix: int = Field(default=0)
    firstUsePhoenixReportsDataMerged: int = Field(default=0)
    lluGettingStartedBanner: int = Field(default=0)
    lluNewFeatureModal: int = Field(default=0)
    lluOnboarding: int = Field(default=0)
    lvWebPostRelease: str = Field(default="")




[docs]
class System(ConfigBaseModel):
    messages: SystemMessages




[docs]
class User(ConfigBaseModel):
    id: str = Field(default="")
    firstName: str = Field(default="")
    lastName: str = Field(default="")
    email: str = Field(default="")
    country: str = Field(default="")
    uiLanguage: str = Field(default="")
    communicationLanguage: str = Field(default="")
    accountType: str = Field(default="")
    uom: str = Field(default="")
    dateFormat: str = Field(default="")
    timeFormat: str = Field(default="")
    emailDay: List[int]
    system: System
    details: dict
    created: int
    lastLogin: int
    programs: dict
    dateOfBirth: int
    practices: dict
    devices: dict
    consents: Consents




[docs]
class Notifications(ConfigBaseModel):
    unresolved: int = Field(default=0)




[docs]
class DataMessages(ConfigBaseModel):
    unread: int = Field(default=0)




[docs]
class AuthTicket(ConfigBaseModel):
    token: str = Field(default="")
    expires: int = Field(default=0)
    duration: int = Field(default=0)




[docs]
class Data(ConfigBaseModel):
    user: User
    messages: DataMessages
    notifications: Notifications
    authTicket: AuthTicket
    invitations: List[str]




[docs]
class LoginResponse(ConfigBaseModel):
    status: int = Field(default=0)
    data: Data




[docs]
class ErrorMessage(ConfigBaseModel):
    message: str = Field(default="")




[docs]
class LoginResponseUnauthenticated(ConfigBaseModel):
    status: int = Field(default=0)
    error: ErrorMessage




[docs]
class LoginRedirectData(ConfigBaseModel):
    redirect: bool = Field(default=False)
    region: str = Field(default="")




[docs]
class LoginRedirectResponse(ConfigBaseModel):
    status: int = Field(default=0)
    data: LoginRedirectData




[docs]
class LoginArgs(ConfigBaseModel):
    email: str = Field(default="")
    password: str = Field(default="")

```

--------------------------------

### PyLibreLinkUp Class

Source: https://pylibrelinkup.readthedocs.io/en/latest/_modules/pylibrelinkup/pylibrelinkup.html

This is the main interface for the PyLibreLinkUp package, where you can authenticate and request data from the LibreLinkUp API. In order to authenticate, you will need to sign up for an account at https://www.librelinkup.com/ and use your email and password to authenticate.

```python
from __future__ import annotations

import hashlib
import warnings
from uuid import UUID

import requests
from pydantic import ValidationError
from requests import HTTPError

from . import LLUAPIRateLimitError
from .api_url import APIUrl
from .data_types import PatientIdentifier
from .decorators import authenticated
from .exceptions import (
    AuthenticationError,
    EmailVerificationError,
    PrivacyPolicyError,
    RedirectError,
    TermsOfUseError,
)
from .models.connection import GraphResponse, LogbookResponse
from .models.data import GlucoseMeasurement, GlucoseMeasurementWithTrend, Patient
from .models.login import LoginArgs, LoginResponse
from .utilities import coerce_patient_id

__all__ = ["PyLibreLinkUp"]


HEADERS: dict[str, str] = {
    "accept-encoding": "gzip",
    "cache-control": "no-cache",
    "connection": "Keep-Alive",
    "content-type": "application/json",
    "product": "llu.android",
    "version": "4.16.0",
}




class PyLibreLinkUp:
    """PyLibreLinkUp class to request data from the LibreLinkUp API."""

    email: str
    password: str
    token: str | None
    account_id_hash: str | None




    def __init__(self, email: str, password: str, api_url: APIUrl = APIUrl.US) -> None:
        """
        Constructor for the PyLibreLinkUp class.

        :param email: The email address for the LibreLinkUp account.
        :type email: str
        :param password: The password for the LibreLinkUp account.
        :type password: str
        :param api_url: The regional API URL to use. Defaults to US.
        :type api_url: APIUrl
        :return: None
        """
        self.login_args: LoginArgs = LoginArgs(email=email, password=password)
        self.email = email or ""
        self.password = password or ""
        self.token = None
        self.account_id_hash = None
        self.api_url: str = api_url.value



    def _call_api(self, url: str) -> dict:
        """Calls the LibreLinkUp API and returns the response

        :type url: str
        :rtype: object
        """
        r = requests.get(url=url, headers=self._get_headers())
        try:
            r.raise_for_status()
        except HTTPError as e:
            if e.response.status_code == 429:
                retry_after = e.response.headers.get("Retry-After", "Unknown")
                raise LLUAPIRateLimitError(
                    response_code=e.response.status_code,
                    message=f"Too many requests. Please try again later.",
                    retry_after=int(retry_after) if retry_after.isdigit() else None,
                )
            else:
                raise
        data = r.json()
        return data

    def _set_token(self, token: str):
        """Saves the token for future requests."""
        self.token = token

    def _set_account_id_hash(self, account_id: str):
        """Saves the account_id_hash for future requests."""
        self.account_id_hash = hashlib.sha256(account_id.encode()).hexdigest()

    def _get_graph_data_json(self, patient_id: UUID) -> dict:
        """Requests and returns patient graph data

        :param patient_id: UUID
        :return:
        """
        return self._call_api(url=f"{self.api_url}/llu/connections/{patient_id}/graph")

    def _get_headers(self) -> dict:
        """Returns the headers for the request."""
        headers = HEADERS.copy()
        if self.token:
            headers.update({"authorization": "Bearer " + self.token})
        if self.account_id_hash:
            headers.update({"account-id": self.account_id_hash})
        return headers

    def _get_logbook_json(self, patient_id: UUID) -> dict:
        """Requests and returns patient logbook data

        :param patient_id: UUID
        :return:
        """
        return self._call_api(
            url=f"{self.api_url}/llu/connections/{patient_id}/logbook"
        )




    def authenticate(self) -> None:
        """Authenticate with the LibreLinkUp API

        :rtype: None
        """
        r = requests.post(
            url=f"{self.api_url}/llu/auth/login",
            headers=self._get_headers(),
            json=self.login_args.model_dump(),
        )
        r.raise_for_status()
        data = r.json()
        # Response to login can either be a request to use a different regional host, just successful, or a request
        # to accept terms or privacy policy.
        data_dict = data.get("data", {})
        if data_dict.get("redirect", False):
            raise RedirectError(APIUrl.from_string(data_dict["region"].upper()))

        match data_dict.get("step", {}).get("type"):
            case "tou":
```

--------------------------------

### AlarmRules Class

Source: https://pylibrelinkup.readthedocs.io/en/latest/_modules/pylibrelinkup/models/config.html

AlarmRules class to store alarm rules data.

```python
from pydantic import Field

from pylibrelinkup.models.base import ConfigBaseModel
from pylibrelinkup.models.data import F, H, L, Nd, Std

__all__ = ["AlarmRules", "FixedLowAlarmValues"]




class AlarmRules(ConfigBaseModel):
    """AlarmRules class to store alarm rules data."""

    c: bool = Field(default=False)
    h: H
    f: F
    l: L
    nd: Nd
    p: int = Field(default=0)
    r: int = Field(default=0)
    std: Std
```

--------------------------------

### latest

Source: https://pylibrelinkup.readthedocs.io/en/latest/_modules/pylibrelinkup/pylibrelinkup.html

Requests and returns the most recent glucose measurement

```python
def latest(
        self,
        patient_identifier: PatientIdentifier
    ) -> GlucoseMeasurementWithTrend:
        """Requests and returns the most recent glucose measurement

        :param patient_identifier: PatientIdentifier: The identifier of the patient.
        :return: The most recent glucose measurement.
        :rtype: GlucoseMeasurementWithTrend
        """
        patient_id = coerce_patient_id(patient_identifier)

        response_json = self._get_graph_data_json(patient_id)

        return GraphResponse.model_validate(response_json).current
```

--------------------------------

### pylibrelinkup.exceptions

Source: https://pylibrelinkup.readthedocs.io/en/latest/_modules/pylibrelinkup/exceptions.html

Source code for the pylibrelinkup.exceptions module.

```python
from .api_url import APIUrl




[docs]
class PyLibreLinkUpError(Exception):
    """Base class for PyLibreLinkUp exceptions."""

    pass





[docs]
class AuthenticationError(PyLibreLinkUpError):
    """Raised when authentication fails."""

    pass





[docs]
class RedirectError(PyLibreLinkUpError):
    """Raised when a redirect is encountered during authentication. This is a signal to retry the request with the new region.
    The new region is stored in the `region` attribute of the exception, which is an APIUrl enum value.
    """

    def __init__(self, region: APIUrl):
        self.region = region
        super().__init__(f"Redirected to {region}")





[docs]
class TermsOfUseError(PyLibreLinkUpError):
    """Raised when the user needs to accept terms of use."""

    def __init__(self):
        super().__init__("User needs to accept terms of use. ")





[docs]
class PrivacyPolicyError(PyLibreLinkUpError):
    """Raised when the user needs to accept the privacy policy."""

    def __init__(self):
        super().__init__("User needs to accept the privacy policy. ")





[docs]
class EmailVerificationError(PyLibreLinkUpError):
    """Raised when the user needs to verify their email."""

    def __init__(self):
        super().__init__("User needs to verify their email. ")





[docs]
class PatientNotFoundError(PyLibreLinkUpError):
    """Raised when a patient with the provided patient_id is not found."""

    def __init__(self):
        super().__init__("Patient not found")





[docs]
class LLUAPIError(PyLibreLinkUpError):
    """Raised when the LibreLinkUp API returns an error."""

    def __init__(self, response_code: int, message: str):
        self.response_code = response_code
        exception_message = f"LLU API returned error {response_code}: {message}"
        super().__init__(exception_message)





[docs]
class LLUAPIRateLimitError(LLUAPIError):
    """Raised when the LibreLinkUp API returns a rate limit error."""

    retry_after: int | None

    def __init__(
        self,
        response_code: int,
        message: str,
        retry_after: int | None = None,
    ):
        self.retry_after = retry_after
        super().__init__(response_code, message)
```

--------------------------------

### FixedLowAlarmValues Class

Source: https://pylibrelinkup.readthedocs.io/en/latest/_modules/pylibrelinkup/models/config.html

FixedLowAlarmValues class to store fixed alarm values.

```python
class FixedLowAlarmValues(ConfigBaseModel):
    """FixedLowAlarmValues class to store fixed alarm values."""

    mgdl: int = Field(default=0)
    mmoll: float = Field(default=0.0)
```

--------------------------------

### ActiveSensor Class

Source: https://pylibrelinkup.readthedocs.io/en/latest/_modules/pylibrelinkup/models/hardware.html

ActiveSensor class to store active sensor data.

```python
[docs]
class ActiveSensor(ConfigBaseModel):
    """ActiveSensor class to store active sensor data."""

    sensor: Sensor
    device: PatientDevice
```

--------------------------------

### Sensor Class

Source: https://pylibrelinkup.readthedocs.io/en/latest/_modules/pylibrelinkup/models/hardware.html

Sensor class to store sensor data.

```python
from pydantic import Field

from .base import ConfigBaseModel
from .config import FixedLowAlarmValues

__all__ = ["Sensor", "PatientDevice", "ActiveSensor"]




[docs]
class Sensor(ConfigBaseModel):
    """Sensor class to store sensor data."""

    device_id: str = Field(default="")
    sn: str = Field(default="")
    a: int = Field(default=0)
    w: int = Field(default=0)
    pt: int = Field(default=0)
```

--------------------------------

### Data JSON Schema (Partial)

Source: https://pylibrelinkup.readthedocs.io/en/latest/api/data.html

The beginning of the JSON schema for the Data model, which includes user, messages, notifications, auth ticket, and invitations.

```json
{
   "title": "Data",
   "type": "object",
   "properties": {
      "user": {
         "$ref": "#/$defs/User"
      },
      "messages": {
         "$ref": "#/$defs/DataMessages"
      },
      "notifications": {
         "$ref": "#/$defs/Notifications"
      },
      "authTicket": {
         "$ref": "#/$defs/AuthTicket"
      },
      "invitations": {
         "items": {
            "type": "string"
         },
         "title": "Invitations",
         "type": "array"
      }
   },
   "$defs": {
      "AuthTicket": {
         "properties": {
            "token": {
               "default": "",

```

--------------------------------

### pylibrelinkup.models.connection Module Code

Source: https://pylibrelinkup.readthedocs.io/en/latest/_modules/pylibrelinkup/models/connection.html

The source code for the pylibrelinkup.models.connection module, including various Pydantic models for data representation and API responses.

```python
import json
from typing import Any, Self
from uuid import UUID

from pydantic import Field, ValidationError, model_validator
from pydantic.functional_validators import ModelWrapValidatorHandler

from .base import ConfigBaseModel
from .config import AlarmRules
from .data import GlucoseMeasurement, GlucoseMeasurementWithTrend
from .hardware import ActiveSensor, PatientDevice, Sensor

__all__ = ["GraphResponse", "LogbookResponse"]

from ..exceptions import PatientNotFoundError


class Connection(ConfigBaseModel):
    """Connection class to store connection data."""

    id: UUID
    patient_id: UUID
    country: str = Field(default="")
    status: int = Field(default=0)
    first_name: str = Field(default="")
    last_name: str = Field(default="")
    target_low: int = Field(default=0)
    target_high: int = Field(default=0)
    uom: int = Field(default=0)
    sensor: Sensor
    alarm_rules: AlarmRules
    glucose_measurement: GlucoseMeasurementWithTrend = Field(alias="glucoseMeasurement")
    glucose_item: GlucoseMeasurement
    glucose_alarm: None
    patient_device: PatientDevice
    created: int = Field(default=0)


class Data(ConfigBaseModel):
    """Data class to store connection data."""

    connection: Connection
    active_sensors: list[ActiveSensor] = Field(alias="activeSensors")
    graph_data: list[GlucoseMeasurement] = Field(alias="graphData")


class Ticket(ConfigBaseModel):
    """TicketData class to store ticket data."""

    token: str = Field(default="")
    expires: int = Field(default=0)
    duration: int = Field(default=0)


class APIResponse(ConfigBaseModel):
    """Base model for API responses."""

    status: int = Field(default=0)
    ticket: Ticket

    @property
    def raw(self):
        """Returns the raw JSON data returned by the API."""
        return self.data.model_dump_json()

    @model_validator(mode="wrap")
    @classmethod
    def validate_api_response(
        cls,
        data: Any,
        handler: ModelWrapValidatorHandler[Self],
    ) -> Self:
        try:
            return handler(data)
        except ValidationError:
            # TODO: Add logging
            # TODO: Extend this to handle other exceptions e.g. redirections, terms of use, etc.
            # if the data is a dictionary, and it should contain an "error" and "status" key
            # match against the status to determine what exception to raise
            # if there's no match, raise the original exception
            if isinstance(data, dict):
                match data:
                    case {
                        "status": 4
                    }:  # 4 is the status code for "couldNotLoadPatient"
                        raise PatientNotFoundError()
            # No match, raise the original exception
            raise




[docs]
class GraphResponse(APIResponse):
    """GraphResponse class to store API graph data endpoint response."""

    data: Data

    @property
    def current(self) -> GlucoseMeasurementWithTrend:
        """Returns the current glucose measurement."""
        return self.data.connection.glucose_measurement

    @property
    def history(self) -> list[GlucoseMeasurement]:
        """Returns the historical glucose measurements."""
        return self.data.graph_data





[docs]
class LogbookResponse(APIResponse):
    """LogbookResponse class to store API logbook data endpoint response."""

    data: list[GlucoseMeasurement]

    @property
    def raw(self):
        """Returns the raw JSON data returned by the API."""
        return json.dumps(
            [json.loads(measurement.model_dump_json()) for measurement in self.data]
        )

```

--------------------------------

### Login Data Structure

Source: https://pylibrelinkup.readthedocs.io/en/latest/api/data.html

Defines the overall data structure for login responses, including user information, messages, notifications, authentication tickets, and invitations.

```json
{
   "user": {
      "firstName": {
         "default": "",
         "title": "Firstname",
         "type": "string"
      },
      "lastName": {
         "default": "",
         "title": "Lastname",
         "type": "string"
      },
      "email": {
         "default": "",
         "title": "Email",
         "type": "string"
      },
      "country": {
         "default": "",
         "title": "Country",
         "type": "string"
      },
      "uiLanguage": {
         "default": "",
         "title": "Uilanguage",
         "type": "string"
      },
      "communicationLanguage": {
         "default": "",
         "title": "Communicationlanguage",
         "type": "string"
      },
      "accountType": {
         "default": "",
         "title": "Accounttype",
         "type": "string"
      },
      "uom": {
         "default": "",
         "title": "Uom",
         "type": "string"
      },
      "dateFormat": {
         "default": "",
         "title": "Dateformat",
         "type": "string"
      },
      "timeFormat": {
         "default": "",
         "title": "Timeformat",
         "type": "string"
      },
      "emailDay": {
         "items": {
            "type": "integer"
         },
         "title": "Emailday",
         "type": "array"
      },
      "system": {
         "$ref": "#/\$defs/System"
      },
      "details": {
         "additionalProperties": true,
         "title": "Details",
         "type": "object"
      },
      "created": {
         "title": "Created",
         "type": "integer"
      },
      "lastLogin": {
         "title": "Lastlogin",
         "type": "integer"
      },
      "programs": {
         "additionalProperties": true,
         "title": "Programs",
         "type": "object"
      },
      "dateOfBirth": {
         "title": "Dateofbirth",
         "type": "integer"
      },
      "practices": {
         "additionalProperties": true,
         "title": "Practices",
         "type": "object"
      },
      "devices": {
         "additionalProperties": true,
         "title": "Devices",
         "type": "object"
      },
      "consents": {
         "$ref": "#/\$defs/Consents"
      }
   },
   "required": [
      "emailDay",
      "system",
      "details",
      "created",
      "lastLogin",
      "programs",
      "dateOfBirth",
      "practices",
      "devices",
      "consents"
   ]
},
   "messages": {
      "title": "DataMessages",
      "type": "object",
      "properties": {
         "unread": {
            "default": 0,
            "title": "Unread",
            "type": "integer"
         }
      }
   },
   "notifications": {
      "title": "Notifications",
      "type": "object",
      "properties": {
         "unread": {
            "default": 0,
            "title": "Unread",
            "type": "integer"
         }
      }
   },
   "authTicket": {
      "title": "AuthTicket",
      "type": "object",
      "properties": {
         "token": {
            "title": "Token",
            "type": "string"
         },
         "expires": {
            "title": "Expires",
            "type": "integer"
         }
      },
      "required": [
         "token",
         "expires"
      ]
   },
   "invitations": {
      "items": {
         "type": "string"
      },
      "title": "Invitations",
      "type": "array"
   }
},
"required": [
   "user",
   "messages",
   "notifications",
   "authTicket",
   "invitations"
]
}
```

--------------------------------

### User Data Structure

Source: https://pylibrelinkup.readthedocs.io/en/latest/api/data.html

Defines the structure of user data, including personal information, system settings, and consent details.

```json
{
   "type": "object",
   "properties": {
      "firstName": {
         "default": "",
         "title": "Firstname",
         "type": "string"
      },
      "lastName": {
         "default": "",
         "title": "Lastname",
         "type": "string"
      },
      "email": {
         "default": "",
         "title": "Email",
         "type": "string"
      },
      "country": {
         "default": "",
         "title": "Country",
         "type": "string"
      },
      "uiLanguage": {
         "default": "",
         "title": "Uilanguage",
         "type": "string"
      },
      "communicationLanguage": {
         "default": "",
         "title": "Communicationlanguage",
         "type": "string"
      },
      "accountType": {
         "default": "",
         "title": "Accounttype",
         "type": "string"
      },
      "uom": {
         "default": "",
         "title": "Uom",
         "type": "string"
      },
      "dateFormat": {
         "default": "",
         "title": "Dateformat",
         "type": "string"
      },
      "timeFormat": {
         "default": "",
         "title": "Timeformat",
         "type": "string"
      },
      "emailDay": {
         "items": {
            "type": "integer"
         },
         "title": "Emailday",
         "type": "array"
      },
      "system": {
         "$ref": "#/\$defs/System"
      },
      "details": {
         "additionalProperties": true,
         "title": "Details",
         "type": "object"
      },
      "created": {
         "title": "Created",
         "type": "integer"
      },
      "lastLogin": {
         "title": "Lastlogin",
         "type": "integer"
      },
      "programs": {
         "additionalProperties": true,
         "title": "Programs",
         "type": "object"
      },
      "dateOfBirth": {
         "title": "Dateofbirth",
         "type": "integer"
      },
      "practices": {
         "additionalProperties": true,
         "title": "Practices",
         "type": "object"
      },
      "devices": {
         "additionalProperties": true,
         "title": "Devices",
         "type": "object"
      },
      "consents": {
         "$ref": "#/\$defs/Consents"
      }
   },
   "required": [
      "emailDay",
      "system",
      "details",
      "created",
      "lastLogin",
      "programs",
      "dateOfBirth",
      "practices",
      "devices",
      "consents"
   ],
   "title": "User",
   "type": "object"
}
```

--------------------------------

### System JSON Schema

Source: https://pylibrelinkup.readthedocs.io/en/latest/api/data.html

The JSON schema for the System model, which contains system-related messages and configurations.

```json
{
   "title": "System",
   "type": "object",
   "properties": {
      "messages": {
         "$ref": "#/$defs/SystemMessages"
      }
   },
   "$defs": {
      "SystemMessages": {
         "properties": {
            "firstUsePhoenix": {
               "default": 0,
               "title": "Firstusephoenix",
               "type": "integer"
            },
            "firstUsePhoenixReportsDataMerged": {
               "default": 0,
               "title": "Firstusephoenixreportsdatamerged",
               "type": "integer"
            },
            "lluGettingStartedBanner": {
               "default": 0,
               "title": "Llugettingstartedbanner",
               "type": "integer"
            },
            "lluNewFeatureModal": {
               "default": 0,
               "title": "Llunewfeaturemodal",
               "type": "integer"
            },
            "lluOnboarding": {
               "default": 0,
               "title": "Lluonboarding",
               "type": "integer"
            },
            "lvWebPostRelease": {
               "default": "",
               "title": "Lvwebpostrelease",
               "type": "string"
            }
         },
         "title": "SystemMessages",
         "type": "object"
      }
   },
   "required": [
      "messages"
   ]
}
```

--------------------------------

### LoginArgs JSON Schema

Source: https://pylibrelinkup.readthedocs.io/en/latest/api/data.html

JSON schema for the LoginArgs model, defining the expected structure for login credentials.

```json
{
   "title": "LoginArgs",
   "type": "object",
   "properties": {
      "email": {
         "default": "",
         "title": "Email",
         "type": "string"
      },
      "password": {
         "default": "",
         "title": "Password",
         "type": "string"
      }
   }
}
```

--------------------------------

### APIUrl Enum

Source: https://pylibrelinkup.readthedocs.io/en/latest/_modules/pylibrelinkup/api_url.html

The APIUrl enum defines the different regional API endpoints for LibreLinkUp.

```python
from __future__ import annotations

from enum import StrEnum
from typing import Type, cast

__all__ = ["APIUrl"]




class APIUrl(StrEnum):
    EU = "https://api-eu.libreview.io"
    EU2 = "https://api-eu2.libreview.io"
    US = "https://api.libreview.io"
    AE = "https://api-ae.libreview.io"
    AP = "https://api-ap.libreview.io"
    AU = "https://api-au.libreview.io"
    CA = "https://api-ca.libreview.io"
    DE = "https://api-de.libreview.io"
    FR = "https://api-fr.libreview.io"
    JP = "https://api-jp.libreview.io"
    LA = "https://api-la.libreview.io"
    RU = "https://api.libreview.ru"

    @classmethod
    def from_string(cls: Type[APIUrl], value: str) -> APIUrl:
        member: APIUrl
        for member in cls:
            if member.name.lower() == value.lower():
                return cast(APIUrl, member)
        raise ValueError(f"{value} is not a valid {cls.__name__}")

```

--------------------------------

### PatientDevice Class

Source: https://pylibrelinkup.readthedocs.io/en/latest/_modules/pylibrelinkup/models/hardware.html

PatientDevice class to store device data.

```python
[docs]
class PatientDevice(ConfigBaseModel):
    """PatientDevice class to store device data."""

    did: str = Field(default="")
    dtid: int = Field(default=0)
    v: str = Field(default="")
    ll: int = Field(default=0)
    hl: int = Field(default=0)
    u: int = Field(default=0)
    fixed_low_alarm_values: FixedLowAlarmValues
    alarms: bool = Field(default=False)
```

--------------------------------

### logbook

Source: https://pylibrelinkup.readthedocs.io/en/latest/_modules/pylibrelinkup/pylibrelinkup.html

Requests and returns patient logbook data, containing the measurements associated with glucose events for approximately the last 14 days.

```python
def logbook(
        self,
        patient_identifier: PatientIdentifier
    ) -> list[GlucoseMeasurement]:
        """Requests and returns patient logbook data, containing the measurements associated with glucose events for approximately the last 14 days.

        :param patient_identifier: PatientIdentifier: The identifier of the patient.
        :return: A list of glucose measurements.
        :rtype: list[GlucoseMeasurement]
        """
        patient_id = coerce_patient_id(patient_identifier)

        response_json = self._get_logbook_json(patient_id)

        return LogbookResponse.model_validate(response_json).data
```

--------------------------------

### read

Source: https://pylibrelinkup.readthedocs.io/en/latest/_modules/pylibrelinkup/pylibrelinkup.html

Requests and returns patient data. This method is deprecated and should be replaced by the `graph` method for retrieving graph data and `latest` for the most recent glucose measurement.

```python
def read(self, patient_identifier: PatientIdentifier) -> GraphResponse:
    """
    .. deprecated:: 0.6.0 The read method is deprecated. Instead, please use the graph method for retrieving graph data,"
        "and latest to access the most recently reported glucose measurement

    Requests and returns patient data

    :param patient_identifier: PatientIdentifier : The identifier of the patient.
    :return: The patient data.
    :rtype: GraphResponse


    """
    # raise a deprecation warning for this method in favor of the graph method
    warnings.warn(
        "The read method is deprecated. Instead, please use the graph method for retrieving graph data,"
        "and latest to access the most recently reported glucose measurement.",
        DeprecationWarning,
    )
    patient_id = coerce_patient_id(patient_identifier)

    response_json = self._get_graph_data_json(patient_id)

    return GraphResponse.model_validate(response_json)
```

--------------------------------

### graph

Source: https://pylibrelinkup.readthedocs.io/en/latest/_modules/pylibrelinkup/pylibrelinkup.html

Requests and returns glucose measurements used to display graph data. Returns approximately the last 12 hours of data.

```python
def graph(self, patient_identifier: PatientIdentifier) -> list[GlucoseMeasurement]:
    """Requests and returns glucose measurements used to display graph data. Returns approximately the last 12 hours of data.

    :param patient_identifier: PatientIdentifier: The identifier of the patient.
    :return: A list of glucose measurements.
    :rtype: list[GlucoseMeasurement]
    """
    patient_id = coerce_patient_id(patient_identifier)

    response_json = self._get_graph_data_json(patient_id)

    return GraphResponse.model_validate(response_json).history
```

--------------------------------

### GlucoseMeasurementWithTrend Data Model Schema (Partial)

Source: https://pylibrelinkup.readthedocs.io/en/latest/api/data.html

Partial JSON schema for the GlucoseMeasurementWithTrend class, which inherits from GlucoseMeasurement.

```json
{

```

--------------------------------

### LoginRedirectResponse JSON Schema

Source: https://pylibrelinkup.readthedocs.io/en/latest/api/data.html

JSON schema for the LoginRedirectResponse model, including status and redirect data.

```json
{
   "title": "LoginRedirectResponse",
   "type": "object",
   "properties": {
      "status": {
         "default": 0,
         "title": "Status",
         "type": "integer"
      },
      "data": {
         "$ref": "#/$defs/LoginRedirectData"
      }
   },
   "$defs": {
      "LoginRedirectData": {
         "properties": {
            "redirect": {
               "default": false,
               "title": "Redirect",
               "type": "boolean"
            },
            "region": {
               "default": "",
               "title": "Region",
               "type": "string"
            }
         },
         "title": "LoginRedirectData",
         "type": "object"
      }
   },
   "required": [
      "data"
   ]
}
```

--------------------------------

### Login Response Schema

Source: https://pylibrelinkup.readthedocs.io/en/latest/api/data.html

JSON schema for the LoginResponse model, detailing its properties and nested structures.

```json
{
   "title": "LoginResponse",
   "type": "object",
   "properties": {
      "status": {
         "default": 0,
         "title": "Status",
         "type": "integer"
      },
      "data": {
         "$ref": "#/$defs/Data"
      }
   },
   "$defs": {
      "AuthTicket": {
         "properties": {
            "token": {
               "default": "",
               "title": "Token",
               "type": "string"
            },
            "expires": {
               "default": 0,
               "title": "Expires",
               "type": "integer"
            },
            "duration": {
               "default": 0,
               "title": "Duration",
               "type": "integer"
            }
         },
         "title": "AuthTicket",
         "type": "object"
      },
      "Consents": {
         "properties": {
            "llu": {
               "$ref": "#/$defs/Llu",
               "default": {
                  "policyAccept": 0,
                  "touAccept": 0
               }
            },
            "realWorldEvidence": {
               "$ref": "#/$defs/RealWorldEvidence",
               "default": {
                  "policyAccept": 0,
                  "declined": false,
                  "touAccept": 0,
                  "history": []
               }
            }
         },
         "title": "Consents",
         "type": "object"
      },
      "Data": {
         "properties": {
            "user": {
               "$ref": "#/$defs/User"
            },
            "messages": {
               "$ref": "#/$defs/DataMessages"
            },
            "notifications": {
               "$ref": "#/$defs/Notifications"
            },
            "authTicket": {
               "$ref": "#/$defs/AuthTicket"
            },
            "invitations": {
               "items": {
                  "type": "string"
               },
               "title": "Invitations",
               "type": "array"
            }
         },
         "required": [
            "user",
            "messages",
            "notifications",
            "authTicket",
            "invitations"
         ],
         "title": "Data",
         "type": "object"
      },
      "DataMessages": {
         "properties": {
            "unread": {
               "default": 0,
               "title": "Unread",
               "type": "integer"
            }
         },
         "title": "DataMessages",
         "type": "object"
      },
      "HistoryItem": {
         "properties": {
            "policyAccept": {
               "default": 0,
               "title": "Policyaccept",
               "type": "integer"
            },
            "declined": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Declined"
            }
         },
         "title": "HistoryItem",
         "type": "object"
      },
      "Llu": {
         "properties": {
            "policyAccept": {
               "default": 0,
               "title": "Policyaccept",
               "type": "integer"
            },
            "touAccept": {
               "default": 0,
               "title": "Touaccept",
               "type": "integer"
            }
         },
         "title": "Llu",
         "type": "object"
      },
      "Notifications": {
         "properties": {
            "unresolved": {
               "default": 0,
               "title": "Unresolved",
               "type": "integer"
            }
         },
         "title": "Notifications",
         "type": "object"
      },
      "RealWorldEvidence": {
         "properties": {
            "policyAccept": {
               "default": 0,
               "title": "Policyaccept",
               "type": "integer"
            },
            "declined": {
               "default": false,
               "title": "Declined",
               "type": "boolean"
            },
            "touAccept": {
               "default": 0,
               "title": "Touaccept",
               "type": "integer"
            },
            "history": {
               "default": [],
               "items": {
                  "$ref": "#/$defs/HistoryItem"
               },
               "title": "History",
               "type": "array"
            }
         },
         "title": "RealWorldEvidence",
         "type": "object"
      },
      "System": {
         "properties": {
            "messages": {
               "$ref": "#/$defs/SystemMessages"
            }
         },
         "required": [
            "messages"
         ],
         "title": "System",

```

--------------------------------

### Data Schema

Source: https://pylibrelinkup.readthedocs.io/en/latest/api/data.html

Schema definition for the 'Data' object, outlining its properties and types.

```json
{
   "type": "object"
},
"SystemMessages": {
   "properties": {
      "firstUsePhoenix": {
         "default": 0,
         "title": "Firstusephoenix",
         "type": "integer"
      },
      "firstUsePhoenixReportsDataMerged": {
         "default": 0,
         "title": "Firstusephoenixreportsdatamerged",
         "type": "integer"
      },
      "lluGettingStartedBanner": {
         "default": 0,
         "title": "Llugettingstartedbanner",
         "type": "integer"
      },
      "lluNewFeatureModal": {
         "default": 0,
         "title": "Llunewfeaturemodal",
         "type": "integer"
      },
      "lluOnboarding": {
         "default": 0,
         "title": "Lluonboarding",
         "type": "integer"
      },
      "lvWebPostRelease": {
         "default": "",
         "title": "Lvwebpostrelease",
         "type": "string"
      }
   },
   "title": "SystemMessages",
   "type": "object"
},
"User": {
   "properties": {
      "id": {
         "default": "",
         "title": "Id",
         "type": "string"
      },
      "firstName": {
         "default": "",
         "title": "Firstname",
         "type": "string"
      },
      "lastName": {
         "default": "",
         "title": "Lastname",
         "type": "string"
      },
      "email": {
         "default": "",
         "title": "Email",
         "type": "string"
      },
      "country": {
         "default": "",
         "title": "Country",
         "type": "string"
      },
      "uiLanguage": {
         "default": "",
         "title": "Uilanguage",
         "type": "string"
      },
      "communicationLanguage": {
         "default": "",
         "title": "Communicationlanguage",
         "type": "string"
      },
      "accountType": {
         "default": "",
         "title": "Accounttype",
         "type": "string"
      },
      "uom": {
         "default": "",
         "title": "Uom",
         "type": "string"
      },
      "dateFormat": {
         "default": "",
         "title": "Dateformat",
         "type": "string"
      },
      "timeFormat": {
         "default": "",
         "title": "Timeformat",
         "type": "string"
      },
      "emailDay": {
         "items": {
            "type": "integer"
         },
         "title": "Emailday",
         "type": "array"
      },
      "system": {
         "$ref": "#/$\\/defs/System"
      },
      "details": {
         "additionalProperties": true,
         "title": "Details",
         "type": "object"
      },
      "created": {
         "title": "Created",
         "type": "integer"
      },
      "lastLogin": {
         "title": "Lastlogin",
         "type": "integer"
      },
      "programs": {
         "additionalProperties": true,
         "title": "Programs",
         "type": "object"
      },
      "dateOfBirth": {
         "title": "Dateofbirth",
         "type": "integer"
      },
      "practices": {
         "additionalProperties": true,
         "title": "Practices",
         "type": "object"
      },
      "devices": {
         "additionalProperties": true,
         "title": "Devices",
         "type": "object"
      },
      "consents": {
         "$ref": "#/$\\/defs/Consents"
      }
   },
   "required": [
      "emailDay",
      "system",
      "details",
      "created",
      "lastLogin",
      "programs",
      "dateOfBirth",
      "practices",
      "devices",
      "consents"
   ],
   "title": "User",
   "type": "object"
}
},
"required": [
   "data"
]
}
```

--------------------------------

### F Class

Source: https://pylibrelinkup.readthedocs.io/en/latest/_modules/pylibrelinkup/models/data.html

F class to store F data.

```python
class F(ConfigBaseModel):
    """F class to store F data."""

    th: int = Field(default=0)
    thmm: float = Field(default=0.0)
    d: int = Field(default=0)
    tl: int = Field(default=0)
    tlmm: float = Field(default=0.0)
```

--------------------------------

### Connections Data Schema

Source: https://pylibrelinkup.readthedocs.io/en/latest/api/data.html

JSON schema for the 'Connections' data, detailing its structure and types.

```json
{
   "title": "Ticket",
   "type": "object"
},
"Trend": {
   "enum": [
      1,
      2,
      3,
      4,
      5
   ],
   "title": "Trend",
   "type": "integer"
}
},
"required": [
   "ticket",
   "data"
]
}
```
Tokens:
Raw