Skip to main content

Nocturne SDK

Project description

nocturne-py

Nocturne V4 API SDK

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 0.1.3
  • Generator version: 7.22.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.10+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import nocturne_py

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import nocturne_py

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import nocturne_py
from nocturne_py.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = nocturne_py.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with nocturne_py.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = nocturne_py.AccessRequestApi(api_client)
    subject_id = 'subject_id_example' # str | 
    approve_access_request_request = nocturne_py.ApproveAccessRequestRequest() # ApproveAccessRequestRequest | 

    try:
        api_instance.access_request_approve(subject_id, approve_access_request_request)
    except ApiException as e:
        print("Exception when calling AccessRequestApi->access_request_approve: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AccessRequestApi access_request_approve POST /api/v4/admin/access-requests/{subjectId}/approve
AccessRequestApi access_request_deny POST /api/v4/admin/access-requests/{subjectId}/deny
AccessRequestApi access_request_get_pending_requests GET /api/v4/admin/access-requests
ActivityApi activity_create_activities POST /api/v4/Activity Create one or more activity records
ActivityApi activity_delete_activity DELETE /api/v4/Activity/{id} Delete an activity record by ID
ActivityApi activity_get_activities GET /api/v4/Activity Get activity records with pagination
ActivityApi activity_get_activity GET /api/v4/Activity/{id} Get a specific activity record by ID
ActivityApi activity_update_activity PUT /api/v4/Activity/{id} Update an existing activity record
AlertCustomSoundsApi alert_custom_sounds_delete_sound DELETE /api/v4/alert-sounds/{id} Delete a custom sound.
AlertCustomSoundsApi alert_custom_sounds_get_sounds GET /api/v4/alert-sounds List all custom sounds for the current tenant (metadata only, no audio data).
AlertCustomSoundsApi alert_custom_sounds_stream_sound GET /api/v4/alert-sounds/{id}/stream Stream the raw audio bytes for a custom sound.
AlertCustomSoundsApi alert_custom_sounds_upload_sound POST /api/v4/alert-sounds Upload a custom alert sound file.
AlertInvitesApi alert_invites_create_invite POST /api/v4/alert-invites Generate an invite link for a follower to join an escalation step.
AlertInvitesApi alert_invites_redeem_invite POST /api/v4/alert-invites/{token}/redeem Redeem an invite token.
AlertInvitesApi alert_invites_revoke_invite DELETE /api/v4/alert-invites/{id} Revoke an unredeemed invite.
AlertInvitesApi alert_invites_validate_invite GET /api/v4/alert-invites/{token} Validate an invite token (public endpoint for redemption flow).
AlertRulesApi alert_rules_create_rule POST /api/v4/alert-rules Create an alert rule with nested schedules, escalation steps, and channels.
AlertRulesApi alert_rules_delete_rule DELETE /api/v4/alert-rules/{id} Delete an alert rule (cascades to schedules, steps, channels).
AlertRulesApi alert_rules_get_rule GET /api/v4/alert-rules/{id} Get a single alert rule with full schedule/escalation tree.
AlertRulesApi alert_rules_get_rules GET /api/v4/alert-rules List all alert rules for the current tenant with schedules and escalation steps.
AlertRulesApi alert_rules_toggle_rule PATCH /api/v4/alert-rules/{id}/toggle Toggle an alert rule enabled/disabled.
AlertRulesApi alert_rules_update_rule PUT /api/v4/alert-rules/{id} Update an alert rule.
AlertsApi alerts_acknowledge POST /api/v4/alerts/acknowledge
AlertsApi alerts_get_active_alerts GET /api/v4/alerts/active List active (unresolved) excursions for the current tenant.
AlertsApi alerts_get_alert_history GET /api/v4/alerts/history Get paginated history of resolved excursions.
AlertsApi alerts_get_pending_deliveries GET /api/v4/alerts/deliveries/pending Get pending deliveries for the specified channel types. Used by bot/adapter services to poll for work.
AlertsApi alerts_mark_delivered POST /api/v4/alerts/deliveries/{deliveryId}/delivered
AlertsApi alerts_mark_failed POST /api/v4/alerts/deliveries/{deliveryId}/failed
AlertsApi alerts_snooze_instance POST /api/v4/alerts/instances/{instanceId}/snooze Snooze an alert instance for the specified duration.
AnalyticsApi analytics_clear_analytics_data DELETE /api/v4/Analytics/data Clears all locally stored analytics data. This action cannot be undone.
AnalyticsApi analytics_get_analytics_status GET /api/v4/Analytics/status Gets the current analytics configuration and collection status.
AnalyticsApi analytics_get_pending_analytics_data GET /api/v4/Analytics/data/pending Gets any pending analytics data queued for collection, returned for transparency. Since data is stored locally only, this is informational.
AnalyticsApi analytics_get_performance_metrics GET /api/v4/Analytics/metrics/performance Gets current system performance metrics such as request latencies and memory usage.
AnalyticsApi analytics_get_privacy_information GET /api/v4/Analytics/privacy Get information about what data is collected and privacy policy
AnalyticsApi analytics_get_usage_statistics GET /api/v4/Analytics/metrics/usage Gets current usage statistics such as endpoint hit counts and feature usage.
AnalyticsApi analytics_track_custom_event POST /api/v4/Analytics/events Tracks a custom AnalyticsEvent. Useful for integration testing or manually recording discrete events. Returns 400 Bad Request if analytics collection is disabled.
AnalyticsApi analytics_update_analytics_config PUT /api/v4/Analytics/config Updates analytics collection configuration.
ApsSnapshotApi aps_snapshot_get_all GET /api/v4/device-status/aps Lists records with pagination, optional date range, device, and source filtering.
ApsSnapshotApi aps_snapshot_get_by_id GET /api/v4/device-status/aps/{id} Retrieves a single record by its unique identifier.
AuditApi audit_get_audit_config GET /api/v4/audit/config Get the audit configuration for the current tenant.
AuditApi audit_get_mutation_audit_log GET /api/v4/audit/mutations Query mutation audit log entries for the current tenant.
AuditApi audit_get_read_access_audit_log GET /api/v4/audit/reads Query read access audit log entries for the current tenant.
AuditApi audit_update_audit_config PUT /api/v4/audit/config Create or update the audit configuration for the current tenant.
AvatarApi avatar_delete DELETE /api/v4/me/avatar Delete the current subject's avatar.
AvatarApi avatar_get GET /api/v4/me/avatar Serve the current subject's avatar image.
AvatarApi avatar_upload POST /api/v4/me/avatar Upload or replace the current subject's avatar. Image is resized to 256x256 WebP.
BGCheckApi b_g_check_create POST /api/v4/observations/bg-checks Creates a new record and returns it with a `Location` header pointing to the created resource.
BGCheckApi b_g_check_delete DELETE /api/v4/observations/bg-checks/{id} Deletes a record by ID.
BGCheckApi b_g_check_get_all GET /api/v4/observations/bg-checks Lists records with pagination, optional date range, device, and source filtering.
BGCheckApi b_g_check_get_by_id GET /api/v4/observations/bg-checks/{id} Retrieves a single record by its unique identifier.
BGCheckApi b_g_check_update PUT /api/v4/observations/bg-checks/{id} Updates an existing record by ID and returns the updated record.
BatteryApi battery_get_battery_readings GET /api/v4/Battery/readings Get battery readings for a device over a time period
BatteryApi battery_get_battery_statistics GET /api/v4/Battery/statistics Get battery statistics for a device or all devices
BatteryApi battery_get_charge_cycles GET /api/v4/Battery/cycles Get charge cycle history for a device
BatteryApi battery_get_current_battery_status GET /api/v4/Battery/current Get the current battery status for all tracked devices
BatteryApi battery_get_known_devices GET /api/v4/Battery/devices Get list of all known devices with battery data
BodyWeightApi body_weight_create POST /api/v4/body-weight Create a single body weight record
BodyWeightApi body_weight_create_body_weights POST /api/v4/body-weight/batch Create one or more body weight records (single object or array)
BodyWeightApi body_weight_delete_body_weight DELETE /api/v4/body-weight/{id} Delete a body weight record by ID
BodyWeightApi body_weight_get_body_weight GET /api/v4/body-weight/{id} Get a specific body weight record by ID
BodyWeightApi body_weight_get_body_weights GET /api/v4/body-weight Get body weight records with optional pagination
BodyWeightApi body_weight_update_body_weight PUT /api/v4/body-weight/{id} Update an existing body weight record
BolusApi bolus_create POST /api/v4/insulin/boluses Creates a new record and returns it with a `Location` header pointing to the created resource.
BolusApi bolus_delete DELETE /api/v4/insulin/boluses/{id} Deletes a record by ID.
BolusApi bolus_delete_by_sync_identifier DELETE /api/v4/insulin/boluses/by-sync-id Delete a bolus by its external sync identifier (dataSource + syncIdentifier pair).
BolusApi bolus_get_all GET /api/v4/insulin/boluses
BolusApi bolus_get_by_id GET /api/v4/insulin/boluses/{id} Retrieves a single record by its unique identifier.
BolusApi bolus_update PUT /api/v4/insulin/boluses/{id} Updates an existing record by ID and returns the updated record.
BolusCalculationApi bolus_calculation_create POST /api/v4/insulin/calculations Creates a new record and returns it with a `Location` header pointing to the created resource.
BolusCalculationApi bolus_calculation_delete DELETE /api/v4/insulin/calculations/{id} Deletes a record by ID.
BolusCalculationApi bolus_calculation_get_all GET /api/v4/insulin/calculations Lists records with pagination, optional date range, device, and source filtering.
BolusCalculationApi bolus_calculation_get_by_id GET /api/v4/insulin/calculations/{id} Retrieves a single record by its unique identifier.
BolusCalculationApi bolus_calculation_update PUT /api/v4/insulin/calculations/{id} Updates an existing record by ID and returns the updated record.
CalibrationApi calibration_create POST /api/v4/glucose/calibrations Creates a new record and returns it with a `Location` header pointing to the created resource.
CalibrationApi calibration_delete DELETE /api/v4/glucose/calibrations/{id} Deletes a record by ID.
CalibrationApi calibration_get_all GET /api/v4/glucose/calibrations
CalibrationApi calibration_get_by_id GET /api/v4/glucose/calibrations/{id} Retrieves a single record by its unique identifier.
CalibrationApi calibration_update PUT /api/v4/glucose/calibrations/{id} Updates an existing record by ID and returns the updated record.
ChartDataApi chart_data_get_dashboard_chart_data GET /api/v4/ChartData/dashboard Gets complete dashboard chart data in a single call. Returns pre-calculated IOB, COB, basal series, categorized treatment markers, state spans, system events, tracker markers, and glucose readings.
ChatIdentityApi chat_identity_claim_link POST /api/v4/chat-identity/links/claim Claim a pending link token after /connect slash command auth.
ChatIdentityApi chat_identity_create_direct_link POST /api/v4/chat-identity/links/direct Directly create a link for the current tenant (used by OAuth2 finalize hop).
ChatIdentityApi chat_identity_get_links GET /api/v4/chat-identity List active chat identity links for the current tenant.
ChatIdentityApi chat_identity_get_pending GET /api/v4/chat-identity/links/pending/{token} Read-only lookup of a pending link token, used by the authorize page to validate and render the confirmation step.
ChatIdentityApi chat_identity_revoke_link DELETE /api/v4/chat-identity/links/{id}
ChatIdentityApi chat_identity_set_default POST /api/v4/chat-identity/links/{id}/set-default
ChatIdentityApi chat_identity_update_link PATCH /api/v4/chat-identity/links/{id}
ChatIdentityDirectoryApi chat_identity_directory_create_pending POST /api/v4/chat-identity/directory/pending-links
ChatIdentityDirectoryApi chat_identity_directory_resolve GET /api/v4/chat-identity/directory/resolve Returns ALL directory candidates for a (platform, platformUserId). Caller is responsible for label disambiguation. Each candidate includes the tenantSlug (joined from tenants table).
ChatIdentityDirectoryApi chat_identity_directory_revoke_by_platform_user DELETE /api/v4/chat-identity/directory/links/{id} Revoke a link by id, verifying the (platform, platformUserId) on the row matches the body. Used by /disconnect from the bot.
ClockFacesApi clock_faces_create POST /api/v4/clockfaces Create a new clock face
ClockFacesApi clock_faces_delete DELETE /api/v4/clockfaces/{id} Delete a clock face (owner only)
ClockFacesApi clock_faces_get_by_id GET /api/v4/clockfaces/{id} Get a clock face configuration by ID (public, no authentication required)
ClockFacesApi clock_faces_list GET /api/v4/clockfaces List all clock faces for the current user
ClockFacesApi clock_faces_update PUT /api/v4/clockfaces/{id} Update an existing clock face (owner only)
CoachMarkApi coach_mark_get_all GET /api/v4/coach-marks Get all coach mark states for the current user.
CoachMarkApi coach_mark_update_status PATCH /api/v4/coach-marks/{key} Update a coach mark's status.
CompatibilityApi compatibility_get_analyses GET /api/v4/compatibility/analyses Get list of analyses with filtering and pagination
CompatibilityApi compatibility_get_analysis_detail GET /api/v4/compatibility/analyses/{id} Get detailed analysis by ID
CompatibilityApi compatibility_get_configuration GET /api/v4/compatibility/config Get current proxy configuration
CompatibilityApi compatibility_get_endpoint_metrics GET /api/v4/compatibility/endpoints Get per-endpoint compatibility metrics
CompatibilityApi compatibility_get_metrics GET /api/v4/compatibility/metrics Get overall compatibility metrics
CompatibilityApi compatibility_test_api_comparison POST /api/v4/compatibility/test Test API compatibility by comparing responses from Nightscout and Nocturne
CompressionLowApi compression_low_accept_suggestion POST /api/v4/compression-lows/suggestions/{id}/accept Accept a suggestion with adjusted bounds
CompressionLowApi compression_low_delete_suggestion DELETE /api/v4/compression-lows/suggestions/{id} Delete a suggestion and its associated state span
CompressionLowApi compression_low_dismiss_suggestion POST /api/v4/compression-lows/suggestions/{id}/dismiss Dismiss a suggestion
CompressionLowApi compression_low_get_suggestion GET /api/v4/compression-lows/suggestions/{id} Get a single suggestion with glucose entries for charting
CompressionLowApi compression_low_get_suggestions GET /api/v4/compression-lows/suggestions Get compression low suggestions with optional filtering
CompressionLowApi compression_low_trigger_detection POST /api/v4/compression-lows/detect Manually trigger detection for a date range (for testing)
ConfigurationApi configuration_delete_configuration DELETE /api/v4/connectors/config/{connectorName} Deletes all configuration and secrets for a connector.
ConfigurationApi configuration_get_all_connector_status GET /api/v4/connectors/config Gets status information for all registered connectors.
ConfigurationApi configuration_get_configuration GET /api/v4/connectors/config/{connectorName} Gets the configuration for a specific connector. Returns runtime configuration only (secrets are not included).
ConfigurationApi configuration_get_effective_configuration GET /api/v4/connectors/config/{connectorName}/effective Gets the effective configuration from a running connector. This returns the actual runtime values including those resolved from environment variables. This endpoint is public since it only exposes non-secret configuration values.
ConfigurationApi configuration_get_schema GET /api/v4/connectors/config/{connectorName}/schema Gets the JSON Schema for a connector's configuration. Schema is generated from the connector's configuration class attributes. This endpoint is public since schema is just metadata, not sensitive data.
ConfigurationApi configuration_save_configuration PUT /api/v4/connectors/config/{connectorName} Saves or updates runtime configuration for a connector. Only properties marked with [RuntimeConfigurable] are accepted. Validates the configuration against the connector's schema before saving.
ConfigurationApi configuration_save_secrets PUT /api/v4/connectors/config/{connectorName}/secrets Saves encrypted secrets for a connector. Secrets are encrypted using AES-256-GCM before storage.
ConfigurationApi configuration_set_active PATCH /api/v4/connectors/config/{connectorName}/active Enables or disables a connector.
ConnectedAppsApi connected_apps_list GET /api/v4/account/connected-apps List all connected apps (OAuth app grants) for the authenticated user on the current tenant.
ConnectedAppsApi connected_apps_revoke DELETE /api/v4/account/connected-apps/{grantId} Revoke a connected app. Soft-deletes the grant and invalidates all associated refresh tokens; previously-issued access tokens become unusable on next request via the revocation cache.
ConnectorFoodEntriesApi connector_food_entries_import_entries POST /api/v4/connector-food-entries/import Import connector food entries.
ConnectorStatusApi connector_status_get_status GET /api/v4/connectors/status Gets the current status and metrics for all registered connectors
CorrelationApi correlation_get_correlated GET /api/v4/correlated/{correlationId} Retrieves all records that share the given correlation ID across every V4 data type.
DataOverviewApi data_overview_get_available_years GET /api/v4/year-overview/years Gets the list of calendar years that contain glucose data and the available data sources.
DataOverviewApi data_overview_get_daily_summary GET /api/v4/year-overview/daily-summary Get day-level aggregated counts and average glucose for a given year
DataOverviewApi data_overview_get_gri_timeline GET /api/v4/year-overview/gri-timeline Get monthly GRI (Glycemic Risk Index) scores for a given year
DebugApi debug_echo_query GET /api/v4/debug/echo/{echo} Echo endpoint for debugging MongoDB queries Returns information about how REST API parameters translate into MongoDB queries
DebugApi debug_echo_query_with_model GET /api/v4/debug/echo/{echo}/{model} Echo endpoint for debugging MongoDB queries with model Returns information about how REST API parameters translate into MongoDB queries
DebugApi debug_echo_query_with_model_and_spec GET /api/v4/debug/echo/{echo}/{model}/{spec} Echo endpoint for debugging MongoDB queries with model and spec Returns information about how REST API parameters translate into MongoDB queries
DebugApi debug_preview_entries POST /api/v4/debug/entries/preview Preview endpoint for entry creation without persistence Allows previewing entry data without actually storing it in the database
DeduplicationApi deduplication_cancel_job POST /api/v4/admin/deduplication/cancel/{jobId}
DeduplicationApi deduplication_get_entry_linked_records GET /api/v4/admin/deduplication/entries/{entryId}/sources
DeduplicationApi deduplication_get_job_status GET /api/v4/admin/deduplication/status/{jobId}
DeduplicationApi deduplication_get_record_linked_records GET /api/v4/admin/deduplication/records/{recordType}/{recordId}/sources
DeduplicationApi deduplication_get_state_span_linked_records GET /api/v4/admin/deduplication/state-spans/{stateSpanId}/sources
DeduplicationApi deduplication_get_treatment_linked_records GET /api/v4/admin/deduplication/treatments/{treatmentId}/sources
DeduplicationApi deduplication_start_deduplication_job POST /api/v4/admin/deduplication/run
DevAdminApi dev_admin_create_tenant POST /api/v4/dev-only/admin/tenants Create a new tenant without authentication (dev-only). Used by the Aspire dashboard "Create Tenant" command.
DevAdminApi dev_admin_delete_tenant DELETE /api/v4/dev-only/admin/tenants/{id} Delete a tenant and all associated data without authentication (dev-only).
DevAdminApi dev_admin_export_snapshot GET /api/v4/dev-only/admin/snapshot Export a full snapshot of all tenants and their identity/config data. Secrets are decrypted to plaintext for portability.
DevAdminApi dev_admin_import_scoped_snapshot POST /api/v4/dev-only/admin/tenants/{id}/import-snapshot Import snapshot data for a single tenant, matched by slug in the provided snapshot. Upserts referenced subjects and passkeys without affecting other tenants.
DevAdminApi dev_admin_import_snapshot POST /api/v4/dev-only/admin/snapshot Import a snapshot, replacing all identity/config data. Wraps the entire operation in a transaction.
DevAdminApi dev_admin_list_tenants GET /api/v4/dev-only/admin/tenants List all tenants with record counts and connector health (dev-only). Used by the Aspire dashboard "List Tenants" command.
DevAdminApi dev_admin_sync_all POST /api/v4/dev-only/admin/sync-all Trigger a sync for every configured connector across all tenants.
DeviceAgeApi device_age_get_all_device_ages GET /api/v4/deviceage/all Get all device ages in a single call
DeviceAgeApi device_age_get_battery_age GET /api/v4/deviceage/battery Get pump battery age (BAGE)
DeviceAgeApi device_age_get_cannula_age GET /api/v4/deviceage/cannula Get cannula/site age (CAGE)
DeviceAgeApi device_age_get_insulin_age GET /api/v4/deviceage/insulin Get insulin reservoir age (IAGE)
DeviceAgeApi device_age_get_sensor_age GET /api/v4/deviceage/sensor Get sensor age (SAGE) Returns both Sensor Start and Sensor Change events
DeviceCatalogApi device_catalog_get_catalog GET /api/v4/devices/catalog Get all known device models.
DeviceCatalogApi device_catalog_get_catalog_by_category GET /api/v4/devices/catalog/{category} Get device models filtered by category.
DeviceEventApi device_event_create POST /api/v4/observations/device-events Creates a new record and returns it with a `Location` header pointing to the created resource.
DeviceEventApi device_event_delete DELETE /api/v4/observations/device-events/{id} Deletes a record by ID.
DeviceEventApi device_event_delete_by_sync_identifier DELETE /api/v4/observations/device-events/by-sync-id Delete a device event by its external sync identifier (dataSource + syncIdentifier pair).
DeviceEventApi device_event_get_all GET /api/v4/observations/device-events Lists records with pagination, optional date range, device, and source filtering.
DeviceEventApi device_event_get_by_id GET /api/v4/observations/device-events/{id} Retrieves a single record by its unique identifier.
DeviceEventApi device_event_update PUT /api/v4/observations/device-events/{id} Updates an existing record by ID and returns the updated record.
DiscrepancyApi discrepancy_get_compatibility_metrics GET /api/v4/Discrepancy/metrics Get overall compatibility metrics for dashboard overview
DiscrepancyApi discrepancy_get_compatibility_status GET /api/v4/Discrepancy/status Get real-time compatibility status summary
DiscrepancyApi discrepancy_get_discrepancy_analyses GET /api/v4/Discrepancy/analyses Get detailed discrepancy analyses with filtering and pagination
DiscrepancyApi discrepancy_get_discrepancy_analysis GET /api/v4/Discrepancy/analyses/{id} Get a specific discrepancy analysis by ID
DiscrepancyApi discrepancy_get_endpoint_metrics GET /api/v4/Discrepancy/endpoints Get per-endpoint compatibility metrics
DiscrepancyApi discrepancy_ingest_discrepancy POST /api/v4/Discrepancy/ingest Receive forwarded discrepancies from remote Nocturne instances
FoodsApi foods_add_favorite POST /api/v4/foods/{foodId}/favorite Add a food to favorites.
FoodsApi foods_create_food POST /api/v4/foods Create a new food record.
FoodsApi foods_delete_food DELETE /api/v4/foods/{foodId} Delete a food from the database, handling any meal attributions that reference it.
FoodsApi foods_get_favorites GET /api/v4/foods/favorites Get current user's favorite foods.
FoodsApi foods_get_food GET /api/v4/foods/{foodId} Get a single food by ID.
FoodsApi foods_get_food_attribution_count GET /api/v4/foods/{foodId}/attribution-count Get how many meal attributions reference a specific food.
FoodsApi foods_get_foods GET /api/v4/foods List foods with optional filtering and pagination. This is a V4 endpoint (not Nightscout-legacy) used by the meal attribution UI.
FoodsApi foods_get_recent_foods GET /api/v4/foods/recent Get recently used foods (excluding favorites).
FoodsApi foods_remove_favorite DELETE /api/v4/foods/{foodId}/favorite Remove a food from favorites.
FoodsApi foods_update_food PUT /api/v4/foods/{foodId} Update an existing food record by ID.
GlucoseProcessingSettingsApi glucose_processing_settings_get_preference GET /api/v4/settings/glucose-processing/preference
GlucoseProcessingSettingsApi glucose_processing_settings_get_source_defaults GET /api/v4/settings/glucose-processing/source-defaults
GlucoseProcessingSettingsApi glucose_processing_settings_set_preference PUT /api/v4/settings/glucose-processing/preference
GlucoseProcessingSettingsApi glucose_processing_settings_set_source_defaults PUT /api/v4/settings/glucose-processing/source-defaults
GuestLinkApi guest_link_activate_guest_link POST /api/v4/guest-links/activate Activate a guest link by code and receive a session cookie.
GuestLinkApi guest_link_create_guest_link POST /api/v4/guest-links Create a new guest link for temporary read-only data sharing.
GuestLinkApi guest_link_get_guest_links GET /api/v4/guest-links List guest links for the current user's effective subject.
GuestLinkApi guest_link_revoke_guest_link DELETE /api/v4/guest-links/{grantId} Revoke an active guest link.
HeartRateApi heart_rate_create_heart_rates POST /api/v4/HeartRate Create one or more heart rate records
HeartRateApi heart_rate_delete_heart_rate DELETE /api/v4/HeartRate/{id} Delete a heart rate record by ID
HeartRateApi heart_rate_get_heart_rate GET /api/v4/HeartRate/{id} Get a specific heart rate record by ID
HeartRateApi heart_rate_get_heart_rates GET /api/v4/HeartRate Get heart rate records with optional pagination and date filtering
HeartRateApi heart_rate_update_heart_rate PUT /api/v4/HeartRate/{id} Update an existing heart rate record
InsulinCatalogApi insulin_catalog_get_catalog GET /api/v4/insulins/catalog Get all known insulin formulations.
InsulinCatalogApi insulin_catalog_get_catalog_by_category GET /api/v4/insulins/catalog/{category} Get insulin formulations filtered by category.
LinkedPlatformsApi linked_platforms_get_linked_platforms GET /api/v4/chat-identity/linked-platforms
MealMatchingApi meal_matching_accept_match POST /api/v4/meal-matching/accept Accept a meal match
MealMatchingApi meal_matching_dismiss_match POST /api/v4/meal-matching/dismiss Dismiss a meal match
MealMatchingApi meal_matching_get_food_entry GET /api/v4/meal-matching/food-entries/{id} Get a food entry for review
MealMatchingApi meal_matching_get_suggestions GET /api/v4/meal-matching/suggestions Get suggested meal matches for a date range
MemberInviteApi member_invite_accept_invite POST /api/v4/member-invites/{token}/accept Accept an invite and join the tenant.
MemberInviteApi member_invite_get_effective_permissions GET /api/v4/member-invites/members/{id}/effective-permissions Get effective permissions for a member (union of role permissions + direct permissions).
MemberInviteApi member_invite_get_followers GET /api/v4/member-invites/members/followers List followers of the current tenant (members with the follower role).
MemberInviteApi member_invite_get_invite_info GET /api/v4/member-invites/{token}/info Get invite info for the accept page (anonymous).
MemberInviteApi member_invite_get_members GET /api/v4/member-invites/members List all members of the current tenant.
MemberInviteApi member_invite_set_member_limit_to24_hours PUT /api/v4/member-invites/members/{id}/limit-to-24-hours Update the 24-hour data limit for a member.
MemberInviteApi member_invite_set_member_permissions PUT /api/v4/member-invites/members/{id}/permissions Set direct permissions for a member.
MemberInviteApi member_invite_set_member_roles PUT /api/v4/member-invites/members/{id}/roles Set roles for a member (replaces all role assignments).
MeterGlucoseApi meter_glucose_create POST /api/v4/glucose/meter Creates a new record and returns it with a `Location` header pointing to the created resource.
MeterGlucoseApi meter_glucose_delete DELETE /api/v4/glucose/meter/{id} Deletes a record by ID.
MeterGlucoseApi meter_glucose_get_all GET /api/v4/glucose/meter
MeterGlucoseApi meter_glucose_get_by_id GET /api/v4/glucose/meter/{id} Retrieves a single record by its unique identifier.
MeterGlucoseApi meter_glucose_update PUT /api/v4/glucose/meter/{id} Updates an existing record by ID and returns the updated record.
MigrationApi migration_cancel_migration POST /api/v4/migration/{jobId}/cancel
MigrationApi migration_get_history GET /api/v4/migration/history
MigrationApi migration_get_pending_config GET /api/v4/migration/pending-config
MigrationApi migration_get_sources GET /api/v4/migration/sources
MigrationApi migration_get_status GET /api/v4/migration/{jobId}/status
MigrationApi migration_start_from_connector POST /api/v4/migration/start-from-connector/{connectorName} Start a migration using saved connector credentials (e.g., after Nightscout connector setup).
MigrationApi migration_start_migration POST /api/v4/migration/start
MigrationApi migration_test_connection POST /api/v4/migration/test
MyFitnessPalSettingsApi my_fitness_pal_settings_get_settings GET /api/v4/connectors/myfitnesspal/settings Get global MyFitnessPal matching settings.
MyFitnessPalSettingsApi my_fitness_pal_settings_save_settings PUT /api/v4/connectors/myfitnesspal/settings Update global MyFitnessPal matching settings.
MyPermissionsApi my_permissions_get_my_permissions GET /api/v4/me/permissions Get the current user's effective granted scopes for the current tenant.
MyTenantsApi my_tenants_create_tenant POST /api/v4/me/tenants
MyTenantsApi my_tenants_get_my_tenants GET /api/v4/me/tenants
MyTenantsApi my_tenants_validate_slug GET /api/v4/me/tenants/validate-slug
NightscoutTransitionApi nightscout_transition_get_transition_status GET /api/v4/nightscout-transition/status Get the current Nightscout transition status including migration progress, write-back health, and disconnect readiness recommendation.
NoteApi note_create POST /api/v4/observations/notes Creates a new record and returns it with a `Location` header pointing to the created resource.
NoteApi note_delete DELETE /api/v4/observations/notes/{id} Deletes a record by ID.
NoteApi note_delete_by_sync_identifier DELETE /api/v4/observations/notes/by-sync-id Delete a note by its external sync identifier (dataSource + syncIdentifier pair).
NoteApi note_get_all GET /api/v4/observations/notes Lists records with pagination, optional date range, device, and source filtering.
NoteApi note_get_by_id GET /api/v4/observations/notes/{id} Retrieves a single record by its unique identifier.
NoteApi note_update PUT /api/v4/observations/notes/{id} Updates an existing record by ID and returns the updated record.
NotificationsApi notifications_create_notification POST /api/v4/notifications Create a notification programmatically (for integrations and services)
NotificationsApi notifications_dismiss_notification DELETE /api/v4/notifications/{id}
NotificationsApi notifications_execute_action POST /api/v4/notifications/{id}/actions/{actionId}
NotificationsApi notifications_get_notifications GET /api/v4/notifications
NutritionApi nutrition_add_carb_intake_food POST /api/v4/nutrition/carbs/{id}/foods Add a food breakdown entry to a carb intake record.
NutritionApi nutrition_create_carb_intake POST /api/v4/nutrition/carbs Create a new carb intake
NutritionApi nutrition_create_meal POST /api/v4/nutrition/meals Atomically create a correlated Bolus + CarbIntake for a meal event. Both records share a single CorrelationId and are persisted within a single transaction. When an existing row matches on (DataSource, SyncIdentifier), the idempotent upsert applies and the response returns 200 instead of 201.
NutritionApi nutrition_delete_carb_intake DELETE /api/v4/nutrition/carbs/{id} Delete a carb intake
NutritionApi nutrition_delete_carb_intake_by_sync_identifier DELETE /api/v4/nutrition/carbs/by-sync-id Delete a carb intake by its external sync identifier (dataSource + syncIdentifier pair).
NutritionApi nutrition_delete_carb_intake_food DELETE /api/v4/nutrition/carbs/{id}/foods/{foodEntryId} Remove a food breakdown entry.
NutritionApi nutrition_get_carb_intake_by_id GET /api/v4/nutrition/carbs/{id} Get a carb intake by ID
NutritionApi nutrition_get_carb_intake_foods GET /api/v4/nutrition/carbs/{id}/foods Get food breakdown for a carb intake record.
NutritionApi nutrition_get_carb_intakes GET /api/v4/nutrition/carbs Get carb intakes with optional filtering
NutritionApi nutrition_get_meals GET /api/v4/nutrition/meals Get meal events grouped by CorrelationId. Each event carries its own carb intakes, correlated boluses, food attribution rows, and aggregated totals. Carb intakes with a null CorrelationId become single-member events on their own (they are NOT collapsed together).
NutritionApi nutrition_update_carb_intake PUT /api/v4/nutrition/carbs/{id} Update an existing carb intake
NutritionApi nutrition_update_carb_intake_food PUT /api/v4/nutrition/carbs/{id}/foods/{foodEntryId} Update a food breakdown entry.
OidcApi oidc_callback GET /api/v4/oidc/callback Handle OIDC callback from provider. Exchanges authorization code for tokens and creates session.
OidcApi oidc_get_linked_identities GET /api/v4/oidc/link/identities List OIDC identities linked to the currently-authenticated subject.
OidcApi oidc_get_providers GET /api/v4/oidc/providers Get available OIDC providers for login.
OidcApi oidc_get_session GET /api/v4/oidc/session Get current session information including authentication status, roles, and permissions.
OidcApi oidc_get_user_info GET /api/v4/oidc/userinfo Get current user information.
OidcApi oidc_link GET /api/v4/oidc/link Initiate the OIDC link flow. Redirects an already-authenticated caller to the OIDC provider's authorization endpoint so they can attach the external identity to their current account.
OidcApi oidc_link_callback GET /api/v4/oidc/link/callback Handle the OIDC link callback. Verifies the authorization code against the IdP, then attaches the external identity to the currently-authenticated subject. Does NOT issue new session cookies.
OidcApi oidc_login GET /api/v4/oidc/login Initiate OIDC login flow Redirects to the OIDC provider's authorization endpoint
OidcApi oidc_logout POST /api/v4/oidc/logout Logout and revoke the session.
OidcApi oidc_refresh POST /api/v4/oidc/refresh Refresh the session tokens. Uses the refresh token to get a new access token.
OidcApi oidc_unlink_identity DELETE /api/v4/oidc/link/identities/{identityId} Unlink an OIDC identity from the currently-authenticated subject. Blocked if this would leave the subject with zero primary auth factors.
OidcProviderAdminApi oidc_provider_admin_create POST /api/v4/admin/oidc-providers
OidcProviderAdminApi oidc_provider_admin_delete DELETE /api/v4/admin/oidc-providers/{id}
OidcProviderAdminApi oidc_provider_admin_disable POST /api/v4/admin/oidc-providers/{id}/disable
OidcProviderAdminApi oidc_provider_admin_enable POST /api/v4/admin/oidc-providers/{id}/enable
OidcProviderAdminApi oidc_provider_admin_get_all GET /api/v4/admin/oidc-providers
OidcProviderAdminApi oidc_provider_admin_get_by_id GET /api/v4/admin/oidc-providers/{id}
OidcProviderAdminApi oidc_provider_admin_get_config_managed GET /api/v4/admin/oidc-providers/config-managed
OidcProviderAdminApi oidc_provider_admin_test_existing POST /api/v4/admin/oidc-providers/{id}/test
OidcProviderAdminApi oidc_provider_admin_test_unsaved POST /api/v4/admin/oidc-providers/test
OidcProviderAdminApi oidc_provider_admin_update PUT /api/v4/admin/oidc-providers/{id}
PatientRecordApi patient_record_create_device POST /api/v4/patient-record/devices Create a new patient device
PatientRecordApi patient_record_create_insulin POST /api/v4/patient-record/insulins Create a new patient insulin
PatientRecordApi patient_record_delete_device DELETE /api/v4/patient-record/devices/{id} Delete a patient device
PatientRecordApi patient_record_delete_insulin DELETE /api/v4/patient-record/insulins/{id} Delete a patient insulin
PatientRecordApi patient_record_get_devices GET /api/v4/patient-record/devices Get all patient devices
PatientRecordApi patient_record_get_insulins GET /api/v4/patient-record/insulins Get all patient insulins
PatientRecordApi patient_record_get_patient_record GET /api/v4/patient-record Get or create the patient record
PatientRecordApi patient_record_update_device PUT /api/v4/patient-record/devices/{id} Update a patient device
PatientRecordApi patient_record_update_insulin PUT /api/v4/patient-record/insulins/{id} Update a patient insulin
PatientRecordApi patient_record_update_patient_record PUT /api/v4/patient-record Update the patient record
PlatformApi platform_create_tenant POST /api/v4/platform/tenants Creates a new tenant with the authenticated subject as owner. Requires MultitenancyConfiguration.AllowSelfServiceCreation to be enabled.
PlatformApi platform_get_tenants GET /api/v4/platform/tenants Returns all tenants the authenticated subject is a member of.
PlatformApi platform_get_transition_status GET /api/v4/platform/transition-status Returns the current multitenancy configuration status. Used by the frontend to display subdomain URLs and transition notices.
PredictionApi prediction_get_predictions GET /api/v4/predictions Get glucose predictions based on current data. Returns predicted glucose values for the next 4 hours in 5-minute intervals.
PredictionApi prediction_get_status GET /api/v4/predictions/status Check the status of the prediction service.
ProcessingApi processing_get_processing_status GET /api/v4/processing/status/{correlationId}
ProcessingApi processing_wait_for_completion GET /api/v4/processing/status/{correlationId}/wait
ProfileApi profile_create_basal_schedule POST /api/v4/profile/basal Create a new basal schedule
ProfileApi profile_create_carb_ratio_schedule POST /api/v4/profile/carb-ratio Create a new carb ratio schedule
ProfileApi profile_create_sensitivity_schedule POST /api/v4/profile/sensitivity Create a new sensitivity schedule
ProfileApi profile_create_target_range_schedule POST /api/v4/profile/target-range Create a new target range schedule
ProfileApi profile_create_therapy_settings POST /api/v4/profile/settings Create a new therapy settings record
ProfileApi profile_delete_basal_schedule DELETE /api/v4/profile/basal/{id} Delete a basal schedule
ProfileApi profile_delete_carb_ratio_schedule DELETE /api/v4/profile/carb-ratio/{id} Delete a carb ratio schedule
ProfileApi profile_delete_sensitivity_schedule DELETE /api/v4/profile/sensitivity/{id} Delete a sensitivity schedule
ProfileApi profile_delete_target_range_schedule DELETE /api/v4/profile/target-range/{id} Delete a target range schedule
ProfileApi profile_delete_therapy_settings DELETE /api/v4/profile/settings/{id} Delete a therapy settings record
ProfileApi profile_get_basal_schedule_by_id GET /api/v4/profile/basal/by-id/{id} Get a basal schedule by ID
ProfileApi profile_get_basal_schedules_by_name GET /api/v4/profile/basal/{profileName} Get basal schedules by profile name
ProfileApi profile_get_carb_ratio_schedule_by_id GET /api/v4/profile/carb-ratio/by-id/{id} Get a carb ratio schedule by ID
ProfileApi profile_get_carb_ratio_schedules_by_name GET /api/v4/profile/carb-ratio/{profileName} Get carb ratio schedules by profile name
ProfileApi profile_get_profile_records GET /api/v4/profile/records Get legacy Nightscout-shaped profile records projected from V4 schedule data. Intended for connector consumption where the caller needs the monolithic Profile shape (store with basal/carbratio/sens/target arrays).
ProfileApi profile_get_profile_summary GET /api/v4/profile/summary Get a consolidated summary of all profile data across all profile names. Optionally provide a date range to include schedule change detection info.
ProfileApi profile_get_sensitivity_schedule_by_id GET /api/v4/profile/sensitivity/by-id/{id} Get a sensitivity schedule by ID
ProfileApi profile_get_sensitivity_schedules_by_name GET /api/v4/profile/sensitivity/{profileName} Get sensitivity schedules by profile name
ProfileApi profile_get_target_range_schedule_by_id GET /api/v4/profile/target-range/by-id/{id} Get a target range schedule by ID
ProfileApi profile_get_target_range_schedules_by_name GET /api/v4/profile/target-range/{profileName} Get target range schedules by profile name
ProfileApi profile_get_therapy_settings GET /api/v4/profile/settings Get all therapy settings with optional filtering
ProfileApi profile_get_therapy_settings_by_id GET /api/v4/profile/settings/{id} Get a therapy settings record by ID
ProfileApi profile_get_therapy_settings_by_name GET /api/v4/profile/settings/by-name/{profileName} Get therapy settings by profile name
ProfileApi profile_update_basal_schedule PUT /api/v4/profile/basal/{id} Update an existing basal schedule
ProfileApi profile_update_carb_ratio_schedule PUT /api/v4/profile/carb-ratio/{id} Update an existing carb ratio schedule
ProfileApi profile_update_sensitivity_schedule PUT /api/v4/profile/sensitivity/{id} Update an existing sensitivity schedule
ProfileApi profile_update_target_range_schedule PUT /api/v4/profile/target-range/{id} Update an existing target range schedule
ProfileApi profile_update_therapy_settings PUT /api/v4/profile/settings/{id} Update an existing therapy settings record
PumpSnapshotApi pump_snapshot_get_all GET /api/v4/device-status/pump Lists records with pagination, optional date range, device, and source filtering.
PumpSnapshotApi pump_snapshot_get_by_id GET /api/v4/device-status/pump/{id} Retrieves a single record by its unique identifier.
RetrospectiveApi retrospective_get_basal_timeline GET /api/v4/Retrospective/basal-timeline Get basal rate timeline for a day Returns basal rate data points showing scheduled and temp basal changes
RetrospectiveApi retrospective_get_retrospective_data GET /api/v4/Retrospective/at Get retrospective data at a specific point in time Returns IOB, COB, glucose, basal rate, and recent treatments
RetrospectiveApi retrospective_get_retrospective_timeline GET /api/v4/Retrospective/timeline Get retrospective data for an entire day at specified interval Returns IOB, COB, glucose, and basal data for every interval throughout the day
RoleApi role_create_role POST /api/v4/roles Create a custom role.
RoleApi role_delete_role DELETE /api/v4/roles/{id} Delete a role.
RoleApi role_get_roles GET /api/v4/roles List roles for the current tenant.
RoleApi role_update_role PUT /api/v4/roles/{id} Update a role.
SensorGlucoseApi sensor_glucose_create POST /api/v4/glucose/sensor
SensorGlucoseApi sensor_glucose_create_sensor_glucose_bulk POST /api/v4/glucose/sensor/bulk Create multiple sensor glucose readings in bulk (max 1000).
SensorGlucoseApi sensor_glucose_delete DELETE /api/v4/glucose/sensor/{id} Deletes a record by ID.
SensorGlucoseApi sensor_glucose_get_all GET /api/v4/glucose/sensor
SensorGlucoseApi sensor_glucose_get_by_id GET /api/v4/glucose/sensor/{id} Retrieves a single record by its unique identifier.
SensorGlucoseApi sensor_glucose_update PUT /api/v4/glucose/sensor/{id}
ServicesApi services_delete_connector_data DELETE /api/v4/services/connectors/{id}/data Delete all data from a specific connector. WARNING: This is a destructive operation that cannot be undone.
ServicesApi services_delete_data_source_data DELETE /api/v4/services/data-sources/{id} Delete all data from a specific data source. WARNING: This is a destructive operation that cannot be undone.
ServicesApi services_delete_demo_data DELETE /api/v4/services/data-sources/demo Delete all demo data. This operation is safe as demo data can be easily regenerated.
ServicesApi services_get_active_data_sources GET /api/v4/services/data-sources Get all active data sources that have been sending data to this Nocturne instance. This includes CGM apps, AID systems, and any other uploaders.
ServicesApi services_get_api_info GET /api/v4/services/api-info Get API endpoint information for configuring external apps. This provides all the information needed to configure xDrip+, Loop, AAPS, etc.
ServicesApi services_get_available_connectors GET /api/v4/services/connectors Get available connectors that can be configured to pull data into Nocturne.
ServicesApi services_get_connector_capabilities GET /api/v4/services/connectors/{id}/capabilities Get capabilities for a specific connector.
ServicesApi services_get_connector_data_summary GET /api/v4/services/connectors/{id}/data-summary Get a summary of data counts for a specific connector. Returns the number of entries, treatments, and device statuses synced by this connector.
ServicesApi services_get_connector_sync_status GET /api/v4/services/connectors/{id}/sync-status Get sync status for a specific connector, including latest timestamps and connector state. Used by connectors on startup to determine where to resume syncing from.
ServicesApi services_get_data_source GET /api/v4/services/data-sources/{id} Get detailed information about a specific data source.
ServicesApi services_get_services_overview GET /api/v4/services Get a complete overview of services, data sources, and available integrations.
ServicesApi services_get_uploader_apps GET /api/v4/services/uploaders Get uploader apps that can push data to Nocturne with setup instructions.
ServicesApi services_get_uploader_setup GET /api/v4/services/uploaders/{appId}/setup Get setup instructions for a specific uploader app.
ServicesApi services_trigger_connector_sync POST /api/v4/services/connectors/{id}/sync Trigger a manual sync for a specific connector.
SetupApi setup_create_tenant POST /api/v4/setup/tenant Create the first tenant on a fresh install. Only succeeds when zero tenants exist.
SetupApi setup_oidc_callback GET /api/v4/setup/oidc/callback OIDC callback for setup owner creation. Called by the OIDC provider after authentication. Links the identity, issues session cookies, and redirects to /setup.
SetupApi setup_owner_complete POST /api/v4/setup/owner/complete Complete passkey registration for the first owner account. Verifies attestation, generates recovery codes, issues a full JWT session.
SetupApi setup_owner_oidc POST /api/v4/setup/owner/oidc Initiate OIDC-based owner creation. Creates the subject and owner role, then redirects to the OIDC provider to link an identity.
SetupApi setup_owner_options POST /api/v4/setup/owner/options Generate passkey registration options for the first owner account. Guard: exactly one tenant must exist with zero non-system members.
SetupApi setup_validate_username GET /api/v4/setup/validate-username Check whether a username is available for the owner account.
StateSpansApi state_spans_create_state_span POST /api/v4/state-spans Create a new state span (manual entry)
StateSpansApi state_spans_delete_state_span DELETE /api/v4/state-spans/{id} Delete a state span
StateSpansApi state_spans_get_activities GET /api/v4/state-spans/activities Get all activity state spans (sleep, exercise, illness, travel)
StateSpansApi state_spans_get_connectivity GET /api/v4/state-spans/connectivity Get connectivity state spans
StateSpansApi state_spans_get_exercise GET /api/v4/state-spans/exercise Get exercise state spans (user-annotated activity periods)
StateSpansApi state_spans_get_illness GET /api/v4/state-spans/illness Get illness state spans (user-annotated illness periods)
StateSpansApi state_spans_get_overrides GET /api/v4/state-spans/overrides Get override state spans
StateSpansApi state_spans_get_profiles GET /api/v4/state-spans/profiles Get profile state spans
StateSpansApi state_spans_get_pump_modes GET /api/v4/state-spans/pump-modes Get pump mode state spans
StateSpansApi state_spans_get_sleep GET /api/v4/state-spans/sleep Get sleep state spans (user-annotated sleep periods)
StateSpansApi state_spans_get_state_span GET /api/v4/state-spans/{id} Get a specific state span by ID
StateSpansApi state_spans_get_state_spans GET /api/v4/state-spans Query all state spans with optional filtering
StateSpansApi state_spans_get_temporary_targets GET /api/v4/state-spans/temporary-targets Get temporary target state spans (AAPS temporary glucose targets)
StateSpansApi state_spans_get_travel GET /api/v4/state-spans/travel Get travel state spans (user-annotated travel/timezone change periods)
StateSpansApi state_spans_update_state_span PUT /api/v4/state-spans/{id} Update an existing state span
StatisticsApi statistics_analyze_glucose_data POST /api/v4/Statistics/comprehensive-analytics Master glucose analytics function that calculates comprehensive metrics
StatisticsApi statistics_analyze_glucose_data_extended POST /api/v4/Statistics/extended-analytics Extended glucose analytics including GMI, GRI, and clinical target assessment
StatisticsApi statistics_assess_against_targets POST /api/v4/Statistics/clinical-assessment Assess glucose data against clinical targets for a specific population
StatisticsApi statistics_assess_data_sufficiency POST /api/v4/Statistics/data-sufficiency Assess data sufficiency for a valid clinical report
StatisticsApi statistics_calculate_averaged_stats POST /api/v4/Statistics/averaged-stats Calculate averaged statistics for each hour of the day (0-23)
StatisticsApi statistics_calculate_basic_stats POST /api/v4/Statistics/basic-stats Calculate basic glucose statistics from provided glucose values
StatisticsApi statistics_calculate_estimated_a1_c GET /api/v4/Statistics/estimated-a1c/{averageGlucose} Calculate estimated A1C from average glucose
StatisticsApi statistics_calculate_glucose_distribution POST /api/v4/Statistics/glucose-distribution Calculate glucose distribution across configurable bins
StatisticsApi statistics_calculate_glycemic_variability POST /api/v4/Statistics/glycemic-variability Calculate comprehensive glycemic variability metrics
StatisticsApi statistics_calculate_gmi GET /api/v4/Statistics/gmi/{meanGlucose} Calculate Glucose Management Indicator (GMI)
StatisticsApi statistics_calculate_gri POST /api/v4/Statistics/gri Calculate Glycemic Risk Index (GRI) from time in range metrics
StatisticsApi statistics_calculate_overall_averages POST /api/v4/Statistics/overall-averages Calculate overall averages across multiple days
StatisticsApi statistics_calculate_site_change_impact POST /api/v4/Statistics/site-change-impact Analyze glucose patterns around site changes to identify impact of site age on control
StatisticsApi statistics_calculate_time_in_range POST /api/v4/Statistics/time-in-range Calculate time in range metrics
StatisticsApi statistics_calculate_treatment_summary POST /api/v4/Statistics/treatment-summary Calculate treatment summary for a collection of boluses and carb intakes
StatisticsApi statistics_clean_treatment_data POST /api/v4/Statistics/clean/treatments Clean and filter treatment data
StatisticsApi statistics_format_carb_display GET /api/v4/Statistics/format/carb/{value} Format carb value for display
StatisticsApi statistics_format_insulin_display GET /api/v4/Statistics/format/insulin/{value} Format insulin value for display
StatisticsApi statistics_get_aid_system_metrics GET /api/v4/Statistics/aid-system-metrics Calculates AID (Automated Insulin Delivery) system metrics for a date range. Uses patient device records to segment the period by algorithm and compute time-weighted metrics via IAidMetricsService.
StatisticsApi statistics_get_basal_analysis GET /api/v4/Statistics/basal-analysis Calculate comprehensive basal analysis statistics for a date range
StatisticsApi statistics_get_clinical_targets GET /api/v4/Statistics/clinical-targets/{population} Get clinical targets for a specific diabetes population
StatisticsApi statistics_get_daily_basal_bolus_ratios GET /api/v4/Statistics/daily-basal-bolus-ratios Calculate daily basal/bolus ratio statistics for a date range
StatisticsApi statistics_get_insulin_delivery_statistics GET /api/v4/Statistics/insulin-delivery-stats Calculate comprehensive insulin delivery statistics for a date range
StatisticsApi statistics_get_multi_period_statistics GET /api/v4/Statistics/periods Gets comprehensive statistics for multiple time periods (1, 3, 7, 30, and 90 days). Fetches sensor glucose, bolus, carb, and temp-basal data from the database for each period, computes GlucoseAnalytics, TreatmentSummary, and InsulinDeliveryStatistics, and caches the result for 5 minutes.
StatisticsApi statistics_mgdl_to_mmol GET /api/v4/Statistics/convert/mgdl-to-mmol/{mgdl} Convert mg/dL to mmol/L
StatisticsApi statistics_mmol_to_mgdl GET /api/v4/Statistics/convert/mmol-to-mgdl/{mmol} Convert mmol/L to mg/dL
StatisticsApi statistics_validate_treatment_data POST /api/v4/Statistics/validate/treatment Validate treatment data for completeness and consistency
StatusApi status_get_health_status GET /api/v4/Status/health Get a simple health check status
StatusApi status_get_status GET /api/v4/Status Get detailed system status information
StepCountApi step_count_create_step_counts POST /api/v4/StepCount Create one or more step count records
StepCountApi step_count_delete_step_count DELETE /api/v4/StepCount/{id} Delete a step count record by ID
StepCountApi step_count_get_step_count GET /api/v4/StepCount/{id} Get a specific step count record by ID
StepCountApi step_count_get_step_counts GET /api/v4/StepCount Get step count records with optional pagination and date filtering
StepCountApi step_count_update_step_count PUT /api/v4/StepCount/{id} Update an existing step count record
SubjectAdminApi subject_admin_set_platform_admin PUT /api/v4/admin/subjects/{id}/platform-admin Grant or revoke platform admin for a subject. Blocks self-demotion if the caller is the last platform admin.
SummaryApi summary_get_summary GET /api/v4/summary Get widget-friendly summary data including current glucose, IOB, COB, trackers, and alarm state.
SupportApi support_create_issue POST /api/v4/support/issues
SupportApi support_get_fallback_url GET /api/v4/support/issues/fallback-url Returns a pre-filled GitHub new-issue URL for fallback when the API is unavailable.
SystemApi system_get_channel_statuses GET /api/v4/system/channels
SystemApi system_heartbeat POST /api/v4/system/heartbeat
SystemEventsApi system_events_create_system_event POST /api/v4/system-events Create a new system event (manual entry or import).
SystemEventsApi system_events_delete_system_event DELETE /api/v4/system-events/{id} Delete a system event.
SystemEventsApi system_events_get_system_event GET /api/v4/system-events/{id} Get a specific system event by ID.
SystemEventsApi system_events_get_system_events GET /api/v4/system-events Query system events with optional filtering.
TenantApi tenant_add_member POST /api/v4/admin/tenants/{id}/members
TenantApi tenant_create POST /api/v4/admin/tenants
TenantApi tenant_create_invite POST /api/v4/admin/tenants/{id}/invites
TenantApi tenant_delete DELETE /api/v4/admin/tenants/{id}
TenantApi tenant_get_all GET /api/v4/admin/tenants
TenantApi tenant_get_by_id GET /api/v4/admin/tenants/{id}
TenantApi tenant_list_invites GET /api/v4/admin/tenants/{id}/invites
TenantApi tenant_provision POST /api/v4/admin/tenants/provision
TenantApi tenant_remove_member DELETE /api/v4/admin/tenants/{id}/members/{subjectId}
TenantApi tenant_revoke_invite DELETE /api/v4/admin/tenants/{id}/invites/{inviteId}
TenantApi tenant_update PUT /api/v4/admin/tenants/{id}
TrackerAlertsApi tracker_alerts_get_available_sounds GET /api/v4/trackers/alerts/sounds Get available alert sounds
TrackerAlertsApi tracker_alerts_get_pending_alerts GET /api/v4/trackers/alerts/pending
TrackersApi trackers_ack_instance POST /api/v4/trackers/instances/{id}/ack Acknowledge/snooze a tracker notification
TrackersApi trackers_apply_preset POST /api/v4/trackers/presets/{id}/apply Apply a preset (starts a new instance)
TrackersApi trackers_complete_instance PUT /api/v4/trackers/instances/{id}/complete Complete a tracker instance
TrackersApi trackers_create_definition POST /api/v4/trackers/definitions Create a new tracker definition
TrackersApi trackers_create_preset POST /api/v4/trackers/presets Create a new preset
TrackersApi trackers_delete_definition DELETE /api/v4/trackers/definitions/{id} Delete a tracker definition
TrackersApi trackers_delete_instance DELETE /api/v4/trackers/instances/{id} Delete a tracker instance
TrackersApi trackers_delete_preset DELETE /api/v4/trackers/presets/{id} Delete a preset
TrackersApi trackers_get_active_instances GET /api/v4/trackers/instances Get active tracker instances
TrackersApi trackers_get_definition GET /api/v4/trackers/definitions/{id} Get a specific tracker definition
TrackersApi trackers_get_definitions GET /api/v4/trackers/definitions Get all tracker definitions. Returns public trackers for unauthenticated users, or all visible trackers for authenticated users.
TrackersApi trackers_get_instance_history GET /api/v4/trackers/instances/history Get completed tracker instances (history)
TrackersApi trackers_get_presets GET /api/v4/trackers/presets Get all presets for the current user
TrackersApi trackers_get_upcoming_instances GET /api/v4/trackers/instances/upcoming Get upcoming tracker expirations for calendar
TrackersApi trackers_start_instance POST /api/v4/trackers/instances Start a new tracker instance
TrackersApi trackers_update_definition PUT /api/v4/trackers/definitions/{id} Update a tracker definition
UISettingsApi u_i_settings_add_or_update_alarm_profile POST /api/v4/ui-settings/notifications/alarms/profiles Save a specific alarm profile.
UISettingsApi u_i_settings_delete_alarm_profile DELETE /api/v4/ui-settings/notifications/alarms/profiles/{profileId} Delete an alarm profile by ID.
UISettingsApi u_i_settings_get_alarm_configuration GET /api/v4/ui-settings/notifications/alarms Get alarm profiles configuration (xDrip+-style).
UISettingsApi u_i_settings_get_section_settings GET /api/v4/ui-settings/{section} Get settings for a specific section.
UISettingsApi u_i_settings_get_ui_settings GET /api/v4/ui-settings Get all UI settings configuration for frontend settings pages. In demo mode, this fetches from the demo service.
UISettingsApi u_i_settings_save_alarm_configuration PUT /api/v4/ui-settings/notifications/alarms Save alarm profiles configuration (xDrip+-style).
UISettingsApi u_i_settings_save_notification_settings PUT /api/v4/ui-settings/notifications Save notification settings including alarm configuration.
UISettingsApi u_i_settings_save_ui_settings PUT /api/v4/ui-settings Save complete UI settings configuration.
UploaderSnapshotApi uploader_snapshot_get_all GET /api/v4/device-status/uploader Lists records with pagination, optional date range, device, and source filtering.
UploaderSnapshotApi uploader_snapshot_get_by_id GET /api/v4/device-status/uploader/{id} Retrieves a single record by its unique identifier.
UserPreferencesApi user_preferences_get_preferences GET /api/v4/user/preferences Get the current user's preferences
UserPreferencesApi user_preferences_update_preferences PATCH /api/v4/user/preferences Update the current user's preferences
WebhookSettingsApi webhook_settings_get_webhook_settings GET /api/v4/ui-settings/notifications/webhooks Gets the webhook notification settings for the current tenant.
WebhookSettingsApi webhook_settings_save_webhook_settings PUT /api/v4/ui-settings/notifications/webhooks Saves webhook notification settings.
WebhookSettingsApi webhook_settings_test_webhook_settings POST /api/v4/ui-settings/notifications/webhooks/test Tests webhook settings by sending test payloads to configured URLs.

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Project details


Download files

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

Source Distribution

nocturne_py-0.1.3.tar.gz (555.9 kB view details)

Uploaded Source

Built Distribution

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

nocturne_py-0.1.3-py3-none-any.whl (1.1 MB view details)

Uploaded Python 3

File details

Details for the file nocturne_py-0.1.3.tar.gz.

File metadata

  • Download URL: nocturne_py-0.1.3.tar.gz
  • Upload date:
  • Size: 555.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for nocturne_py-0.1.3.tar.gz
Algorithm Hash digest
SHA256 2e23a9934fc3836badb3c1d50e2dc3412ae2c37e5e10307f941f2d17a9c91dab
MD5 1df906549f093c2a7e3648262a8a4bae
BLAKE2b-256 3b3c584969209a77ed00bacff3789c7e70c22c9689921a5fcf5e531142c127dd

See more details on using hashes here.

Provenance

The following attestation bundles were made for nocturne_py-0.1.3.tar.gz:

Publisher: sdk-publish.yml on nightscout/nocturne

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

File details

Details for the file nocturne_py-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: nocturne_py-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 1.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for nocturne_py-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ee7e75e5b042f50ebc1d5256c048e7bb2a50b791a57d0e1bb5a4b3d7f9350d3e
MD5 76edbbff4a4b2a672f6dbb0575d41b13
BLAKE2b-256 c5e2eb49f1dec42cf680fafd951a5b6aa9d7b6f547a5a2f44813af87f1eda64a

See more details on using hashes here.

Provenance

The following attestation bundles were made for nocturne_py-0.1.3-py3-none-any.whl:

Publisher: sdk-publish.yml on nightscout/nocturne

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

Supported by

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