@nightscoutfoundation/nocturne

v0.1.0

Published

a month ago

OpenAPI client for @nightscoutfoundation/nocturne

0High
0Medium
0Low

twistatim

scottleibrand

rcgy

@nightscoutfoundation/[email protected]

A TypeScript SDK client for the localhost API.

Usage

First, install the SDK from npm.

npm install @nightscoutfoundation/nocturne --save

Next, try it out.

import {
  Configuration,
  AnalyticsApi,
} from '@nightscoutfoundation/nocturne';
import type { AnalyticsClearAnalyticsDataRequest } from '@nightscoutfoundation/nocturne';

async function example() {
  console.log("🚀 Testing @nightscoutfoundation/nocturne SDK...");
  const api = new AnalyticsApi();

  try {
    const data = await api.analyticsClearAnalyticsData();
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to http://localhost

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- AnalyticsApi | analyticsClearAnalyticsData | DELETE /api/v4/Analytics/data | Clear all stored analytics data AnalyticsApi | analyticsGetAnalyticsStatus | GET /api/v4/Analytics/status | Get the current analytics configuration and status AnalyticsApi | analyticsGetPendingAnalyticsData | GET /api/v4/Analytics/data/pending | Get pending analytics data that would be transmitted (for transparency) AnalyticsApi | analyticsGetPerformanceMetrics | GET /api/v4/Analytics/metrics/performance | Get current performance metrics AnalyticsApi | analyticsGetPrivacyInformation | GET /api/v4/Analytics/privacy | Get information about what data is collected and privacy policy AnalyticsApi | analyticsGetUsageStatistics | GET /api/v4/Analytics/metrics/usage | Get current usage statistics AnalyticsApi | analyticsTrackCustomEvent | POST /api/v4/Analytics/events | Track a custom analytics event (for testing or manual tracking) AnalyticsApi | analyticsUpdateAnalyticsConfig | PUT /api/v4/Analytics/config | Update analytics collection configuration CompatibilityApi | compatibilityGetAnalyses | GET /api/v4/compatibility/analyses | Get list of analyses with filtering and pagination CompatibilityApi | compatibilityGetAnalysisDetail | GET /api/v4/compatibility/analyses/{id} | Get detailed analysis by ID CompatibilityApi | compatibilityGetConfiguration | GET /api/v4/compatibility/config | Get current proxy configuration CompatibilityApi | compatibilityGetEndpointMetrics | GET /api/v4/compatibility/endpoints | Get per-endpoint compatibility metrics CompatibilityApi | compatibilityGetMetrics | GET /api/v4/compatibility/metrics | Get overall compatibility metrics CompatibilityApi | compatibilityTestApiComparison | POST /api/v4/compatibility/test | Test API compatibility by comparing responses from Nightscout and Nocturne MemberInvitesApi | memberInviteAcceptInvite | POST /api/v4/member-invites/{token}/accept | Accept an invite and join the tenant. MemberInvitesApi | memberInviteGetEffectivePermissions | GET /api/v4/member-invites/members/{id}/effective-permissions | Get effective permissions for a member (union of role permissions + direct permissions). MemberInvitesApi | memberInviteGetFollowers | GET /api/v4/member-invites/members/followers | List followers of the current tenant (members with the follower role). MemberInvitesApi | memberInviteGetInviteInfo | GET /api/v4/member-invites/{token}/info | Get invite info for the accept page (anonymous). MemberInvitesApi | memberInviteGetMembers | GET /api/v4/member-invites/members | List all members of the current tenant. MemberInvitesApi | memberInviteSetMemberPermissions | PUT /api/v4/member-invites/members/{id}/permissions | Set direct permissions for a member. MemberInvitesApi | memberInviteSetMemberRoles | PUT /api/v4/member-invites/members/{id}/roles | Set roles for a member (replaces all role assignments). MigrationApi | migrationCancelMigration | POST /api/v4/migration/{jobId}/cancel | Cancel a running migration job MigrationApi | migrationGetHistory | GET /api/v4/migration/history | Get migration job history MigrationApi | migrationGetPendingConfig | GET /api/v4/migration/pending-config | Get pending migration configuration from environment variables MigrationApi | migrationGetSources | GET /api/v4/migration/sources | Get saved migration sources with their last migration timestamps MigrationApi | migrationGetStatus | GET /api/v4/migration/{jobId}/status | Get the status of a migration job MigrationApi | migrationStartMigration | POST /api/v4/migration/start | Start a new migration job MigrationApi | migrationTestConnection | POST /api/v4/migration/test | Test a migration source connection MyPermissionsApi | myPermissionsGetMyPermissions | GET /api/v4/me/permissions | Get the current user's effective granted scopes for the current tenant. MyTenantsApi | myTenantsCreateTenant | POST /api/v4/me/tenants | MyTenantsApi | myTenantsGetMyTenants | GET /api/v4/me/tenants | MyTenantsApi | myTenantsValidateSlug | GET /api/v4/me/tenants/validate-slug | RolesApi | roleCreateRole | POST /api/v4/roles | Create a custom role. RolesApi | roleDeleteRole | DELETE /api/v4/roles/{id} | Delete a role. RolesApi | roleGetRoles | GET /api/v4/roles | List roles for the current tenant. RolesApi | roleUpdateRole | PUT /api/v4/roles/{id} | Update a role. StateSpansApi | stateSpansCreateStateSpan | POST /api/v4/state-spans | Create a new state span (manual entry) StateSpansApi | stateSpansDeleteStateSpan | DELETE /api/v4/state-spans/{id} | Delete a state span StateSpansApi | stateSpansGetActivities | GET /api/v4/state-spans/activities | Get all activity state spans (sleep, exercise, illness, travel) StateSpansApi | stateSpansGetConnectivity | GET /api/v4/state-spans/connectivity | Get connectivity state spans StateSpansApi | stateSpansGetExercise | GET /api/v4/state-spans/exercise | Get exercise state spans (user-annotated activity periods) StateSpansApi | stateSpansGetIllness | GET /api/v4/state-spans/illness | Get illness state spans (user-annotated illness periods) StateSpansApi | stateSpansGetOverrides | GET /api/v4/state-spans/overrides | Get override state spans StateSpansApi | stateSpansGetProfiles | GET /api/v4/state-spans/profiles | Get profile state spans StateSpansApi | stateSpansGetPumpModes | GET /api/v4/state-spans/pump-modes | Get pump mode state spans StateSpansApi | stateSpansGetSleep | GET /api/v4/state-spans/sleep | Get sleep state spans (user-annotated sleep periods) StateSpansApi | stateSpansGetStateSpan | GET /api/v4/state-spans/{id} | Get a specific state span by ID StateSpansApi | stateSpansGetStateSpans | GET /api/v4/state-spans | Query all state spans with optional filtering StateSpansApi | stateSpansGetTemporaryTargets | GET /api/v4/state-spans/temporary-targets | Get temporary target state spans (AAPS temporary glucose targets) StateSpansApi | stateSpansGetTravel | GET /api/v4/state-spans/travel | Get travel state spans (user-annotated travel/timezone change periods) StateSpansApi | stateSpansUpdateStateSpan | PUT /api/v4/state-spans/{id} | Update an existing state span StatusApi | statusGetHealthStatus | GET /api/v4/Status/health | Get a simple health check status StatusApi | statusGetStatus | GET /api/v4/Status | Get detailed system status information SystemEventsApi | systemEventsCreateSystemEvent | POST /api/v4/system-events | Create a new system event (manual entry or import) SystemEventsApi | systemEventsDeleteSystemEvent | DELETE /api/v4/system-events/{id} | Delete a system event SystemEventsApi | systemEventsGetSystemEvent | GET /api/v4/system-events/{id} | Get a specific system event by ID SystemEventsApi | systemEventsGetSystemEvents | GET /api/v4/system-events | Query system events with optional filtering UISettingsApi | uISettingsAddOrUpdateAlarmProfile | POST /api/v4/ui-settings/notifications/alarms/profiles | Save a specific alarm profile. UISettingsApi | uISettingsDeleteAlarmProfile | DELETE /api/v4/ui-settings/notifications/alarms/profiles/{profileId} | Delete an alarm profile by ID. UISettingsApi | uISettingsGetAlarmConfiguration | GET /api/v4/ui-settings/notifications/alarms | Get alarm profiles configuration (xDrip+-style). UISettingsApi | uISettingsGetSectionSettings | GET /api/v4/ui-settings/{section} | Get settings for a specific section. UISettingsApi | uISettingsGetUISettings | GET /api/v4/ui-settings | Get all UI settings configuration for frontend settings pages. In demo mode, this fetches from the demo service. UISettingsApi | uISettingsSaveAlarmConfiguration | PUT /api/v4/ui-settings/notifications/alarms | Save alarm profiles configuration (xDrip+-style). UISettingsApi | uISettingsSaveNotificationSettings | PUT /api/v4/ui-settings/notifications | Save notification settings including alarm configuration. UISettingsApi | uISettingsSaveUISettings | PUT /api/v4/ui-settings | Save complete UI settings configuration. UserPreferencesApi | userPreferencesGetPreferences | GET /api/v4/user/preferences | Get the current user's preferences UserPreferencesApi | userPreferencesUpdatePreferences | PATCH /api/v4/user/preferences | Update the current user's preferences V4APSSnapshotsApi | apsSnapshotGetAll | GET /api/v4/device-status/aps | V4APSSnapshotsApi | apsSnapshotGetById | GET /api/v4/device-status/aps/{id} | V4AdminApi | backfillTriggerBackfill | POST /api/v4/admin/backfill | Trigger a full backfill of legacy entries and treatments into v4 granular tables. This operation is idempotent and safe to re-run. Records are matched by LegacyId to avoid creating duplicates. Only one backfill can run at a time. V4AlertInvitesApi | alertInvitesCreateInvite | POST /api/v4/alert-invites | Generate an invite link for a follower to join an escalation step. V4AlertInvitesApi | alertInvitesRedeemInvite | POST /api/v4/alert-invites/{token}/redeem | Redeem an invite token. V4AlertInvitesApi | alertInvitesRevokeInvite | DELETE /api/v4/alert-invites/{id} | Revoke an unredeemed invite. V4AlertInvitesApi | alertInvitesValidateInvite | GET /api/v4/alert-invites/{token} | Validate an invite token (public endpoint for redemption flow). V4AlertRulesApi | alertRulesCreateRule | POST /api/v4/alert-rules | Create an alert rule with nested schedules, escalation steps, and channels. V4AlertRulesApi | alertRulesDeleteRule | DELETE /api/v4/alert-rules/{id} | Delete an alert rule (cascades to schedules, steps, channels). V4AlertRulesApi | alertRulesGetRule | GET /api/v4/alert-rules/{id} | Get a single alert rule with full schedule/escalation tree. V4AlertRulesApi | alertRulesGetRules | GET /api/v4/alert-rules | List all alert rules for the current tenant with schedules and escalation steps. V4AlertRulesApi | alertRulesToggleRule | PATCH /api/v4/alert-rules/{id}/toggle | Toggle an alert rule enabled/disabled. V4AlertRulesApi | alertRulesUpdateRule | PUT /api/v4/alert-rules/{id} | Update an alert rule. V4AlertSoundsApi | alertCustomSoundsDeleteSound | DELETE /api/v4/alert-sounds/{id} | Delete a custom sound. V4AlertSoundsApi | alertCustomSoundsGetSounds | GET /api/v4/alert-sounds | List all custom sounds for the current tenant (metadata only, no audio data). V4AlertSoundsApi | alertCustomSoundsStreamSound | GET /api/v4/alert-sounds/{id}/stream | Stream the raw audio bytes for a custom sound. V4AlertSoundsApi | alertCustomSoundsUploadSound | POST /api/v4/alert-sounds | Upload a custom alert sound file. V4AlertsApi | alertsAcknowledge | POST /api/v4/alerts/acknowledge | Acknowledge all active alerts for the current tenant. V4AlertsApi | alertsGetActiveAlerts | GET /api/v4/alerts/active | List active (unresolved) excursions for the current tenant. V4AlertsApi | alertsGetAlertHistory | GET /api/v4/alerts/history | Get paginated history of resolved excursions. V4AlertsApi | alertsGetPendingDeliveries | GET /api/v4/alerts/deliveries/pending | Get pending deliveries for the specified channel types. Used by bot/adapter services to poll for work. V4AlertsApi | alertsGetQuietHours | GET /api/v4/alerts/quiet-hours | Get the current quiet hours configuration for the tenant. V4AlertsApi | alertsMarkDelivered | POST /api/v4/alerts/deliveries/{deliveryId}/delivered | Mark a delivery as successfully sent by the channel adapter. V4AlertsApi | alertsMarkFailed | POST /api/v4/alerts/deliveries/{deliveryId}/failed | Mark a delivery as failed by the channel adapter. V4AlertsApi | alertsSnoozeInstance | POST /api/v4/alerts/instances/{instanceId}/snooze | Snooze an alert instance for the specified duration. V4AlertsApi | alertsUpdateQuietHours | PUT /api/v4/alerts/quiet-hours | Update quiet hours configuration for the tenant. V4BGChecksApi | bGCheckCreate | POST /api/v4/observations/bg-checks | V4BGChecksApi | bGCheckDelete | DELETE /api/v4/observations/bg-checks/{id} | V4BGChecksApi | bGCheckGetAll | GET /api/v4/observations/bg-checks | V4BGChecksApi | bGCheckGetById | GET /api/v4/observations/bg-checks/{id} | V4BGChecksApi | bGCheckUpdate | PUT /api/v4/observations/bg-checks/{id} | V4BatteryApi | batteryGetBatteryReadings | GET /api/v4/Battery/readings | Get battery readings for a device over a time period V4BatteryApi | batteryGetBatteryStatistics | GET /api/v4/Battery/statistics | Get battery statistics for a device or all devices V4BatteryApi | batteryGetChargeCycles | GET /api/v4/Battery/cycles | Get charge cycle history for a device V4BatteryApi | batteryGetCurrentBatteryStatus | GET /api/v4/Battery/current | Get the current battery status for all tracked devices V4BatteryApi | batteryGetKnownDevices | GET /api/v4/Battery/devices | Get list of all known devices with battery data V4BolusCalculationsApi | bolusCalculationCreate | POST /api/v4/insulin/calculations | V4BolusCalculationsApi | bolusCalculationDelete | DELETE /api/v4/insulin/calculations/{id} | V4BolusCalculationsApi | bolusCalculationGetAll | GET /api/v4/insulin/calculations | V4BolusCalculationsApi | bolusCalculationGetById | GET /api/v4/insulin/calculations/{id} | V4BolusCalculationsApi | bolusCalculationUpdate | PUT /api/v4/insulin/calculations/{id} | V4BolusesApi | bolusCreate | POST /api/v4/insulin/boluses | V4BolusesApi | bolusDelete | DELETE /api/v4/insulin/boluses/{id} | V4BolusesApi | bolusGetAll | GET /api/v4/insulin/boluses | V4BolusesApi | bolusGetById | GET /api/v4/insulin/boluses/{id} | V4BolusesApi | bolusUpdate | PUT /api/v4/insulin/boluses/{id} | V4CalibrationsApi | calibrationCreate | POST /api/v4/glucose/calibrations | V4CalibrationsApi | calibrationDelete | DELETE /api/v4/glucose/calibrations/{id} | V4CalibrationsApi | calibrationGetAll | GET /api/v4/glucose/calibrations | V4CalibrationsApi | calibrationGetById | GET /api/v4/glucose/calibrations/{id} | V4CalibrationsApi | calibrationUpdate | PUT /api/v4/glucose/calibrations/{id} | V4ChartDataApi | chartDataGetDashboardChartData | GET /api/v4/ChartData/dashboard | Get 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. V4ChatIdentityApi | chatIdentityCreateLink | POST /api/v4/chat-identity | Create a new chat identity link. V4ChatIdentityApi | chatIdentityGetLinks | GET /api/v4/chat-identity | List active chat identity links for the current tenant. V4ChatIdentityApi | chatIdentityResolve | GET /api/v4/chat-identity/resolve | Resolve a platform identity to a Nocturne user. Used by the bot service to look up which tenant/user a chat message belongs to. V4ChatIdentityApi | chatIdentityRevokeLink | DELETE /api/v4/chat-identity/{id} | Revoke (soft-delete) a chat identity link. V4ClockFacesApi | clockFacesCreate | POST /api/v4/clockfaces | Create a new clock face V4ClockFacesApi | clockFacesDelete | DELETE /api/v4/clockfaces/{id} | Delete a clock face (owner only) V4ClockFacesApi | clockFacesGetById | GET /api/v4/clockfaces/{id} | Get a clock face configuration by ID (public, no authentication required) V4ClockFacesApi | clockFacesList | GET /api/v4/clockfaces | List all clock faces for the current user V4ClockFacesApi | clockFacesUpdate | PUT /api/v4/clockfaces/{id} | Update an existing clock face (owner only) V4CompressionLowsApi | compressionLowAcceptSuggestion | POST /api/v4/compression-lows/suggestions/{id}/accept | Accept a suggestion with adjusted bounds V4CompressionLowsApi | compressionLowDeleteSuggestion | DELETE /api/v4/compression-lows/suggestions/{id} | Delete a suggestion and its associated state span V4CompressionLowsApi | compressionLowDismissSuggestion | POST /api/v4/compression-lows/suggestions/{id}/dismiss | Dismiss a suggestion V4CompressionLowsApi | compressionLowGetSuggestion | GET /api/v4/compression-lows/suggestions/{id} | Get a single suggestion with glucose entries for charting V4CompressionLowsApi | compressionLowGetSuggestions | GET /api/v4/compression-lows/suggestions | Get compression low suggestions with optional filtering V4CompressionLowsApi | compressionLowTriggerDetection | POST /api/v4/compression-lows/detect | Manually trigger detection for a date range (for testing) V4ConnectorFoodEntriesApi | connectorFoodEntriesImportEntries | POST /api/v4/connector-food-entries/import | Import connector food entries. V4ConnectorSettingsApi | myFitnessPalSettingsGetSettings | GET /api/v4/connectors/myfitnesspal/settings | Get global MyFitnessPal matching settings. V4ConnectorSettingsApi | myFitnessPalSettingsSaveSettings | PUT /api/v4/connectors/myfitnesspal/settings | Update global MyFitnessPal matching settings. V4CorrelationApi | correlationGetCorrelated | GET /api/v4/correlated/{correlationId} | Get all data correlated by a shared correlation ID across all V4 data types V4DataOverviewApi | dataOverviewGetAvailableYears | GET /api/v4/year-overview/years | Get the list of years that contain data and available data sources V4DataOverviewApi | dataOverviewGetDailySummary | GET /api/v4/year-overview/daily-summary | Get day-level aggregated counts and average glucose for a given year V4DataOverviewApi | dataOverviewGetGriTimeline | GET /api/v4/year-overview/gri-timeline | Get monthly GRI (Glycemic Risk Index) scores for a given year V4DebugApi | debugCreateSimpleTestNotification | GET /api/v4/debug/test/notification | Simple test endpoint for creating in-app notifications without authentication Creates a test notification to verify the real-time notification system is working V4DebugApi | debugCreateTestNotification | POST /api/v4/debug/test/inappnotification | Test endpoint for creating in-app notifications (development only) Creates a test notification for the current user to verify the notification system V4DebugApi | debugEchoQuery | GET /api/v4/debug/echo/{echo} | Echo endpoint for debugging MongoDB queries Returns information about how REST API parameters translate into MongoDB queries V4DebugApi | debugEchoQueryWithModel | 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 V4DebugApi | debugEchoQueryWithModelAndSpec | 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 V4DebugApi | debugPreviewEntries | POST /api/v4/debug/entries/preview | Preview endpoint for entry creation without persistence Allows previewing entry data without actually storing it in the database V4DebugApi | debugTestSignalRBroadcast | GET /api/v4/debug/test/signalr-broadcast | Test endpoint to broadcast a raw SignalR notification event This bypasses the database and directly tests the SignalR broadcast V4DeduplicationApi | deduplicationCancelJob | POST /api/v4/admin/deduplication/cancel/{jobId} | Cancel a running deduplication job. V4DeduplicationApi | deduplicationGetEntryLinkedRecords | GET /api/v4/admin/deduplication/entries/{entryId}/sources | Get linked records for a specific entry by its canonical group. V4DeduplicationApi | deduplicationGetJobStatus | GET /api/v4/admin/deduplication/status/{jobId} | Get the status of a deduplication job. V4DeduplicationApi | deduplicationGetRecordLinkedRecords | GET /api/v4/admin/deduplication/records/{recordType}/{recordId}/sources | Get linked records for any V4 record type by its canonical group. V4DeduplicationApi | deduplicationGetStateSpanLinkedRecords | GET /api/v4/admin/deduplication/state-spans/{stateSpanId}/sources | Get linked records for a specific state span by its canonical group. V4DeduplicationApi | deduplicationGetTreatmentLinkedRecords | GET /api/v4/admin/deduplication/treatments/{treatmentId}/sources | Get linked records for a specific treatment by its canonical group. V4DeduplicationApi | deduplicationStartDeduplicationJob | POST /api/v4/admin/deduplication/run | Start a deduplication job to link related records from different data sources. The job runs in the background and can be monitored using the status endpoint. V4DeviceAgeApi | deviceAgeGetAllDeviceAges | GET /api/v4/deviceage/all | Get all device ages in a single call V4DeviceAgeApi | deviceAgeGetBatteryAge | GET /api/v4/deviceage/battery | Get pump battery age (BAGE) V4DeviceAgeApi | deviceAgeGetCannulaAge | GET /api/v4/deviceage/cannula | Get cannula/site age (CAGE) V4DeviceAgeApi | deviceAgeGetInsulinAge | GET /api/v4/deviceage/insulin | Get insulin reservoir age (IAGE) V4DeviceAgeApi | deviceAgeGetSensorAge | GET /api/v4/deviceage/sensor | Get sensor age (SAGE) Returns both Sensor Start and Sensor Change events V4DeviceEventsApi | deviceEventCreate | POST /api/v4/observations/device-events | V4DeviceEventsApi | deviceEventDelete | DELETE /api/v4/observations/device-events/{id} | V4DeviceEventsApi | deviceEventGetAll | GET /api/v4/observations/device-events | V4DeviceEventsApi | deviceEventGetById | GET /api/v4/observations/device-events/{id} | V4DeviceEventsApi | deviceEventUpdate | PUT /api/v4/observations/device-events/{id} | V4DiscrepancyApi | discrepancyGetCompatibilityMetrics | GET /api/v4/Discrepancy/metrics | Get overall compatibility metrics for dashboard overview V4DiscrepancyApi | discrepancyGetCompatibilityStatus | GET /api/v4/Discrepancy/status | Get real-time compatibility status summary V4DiscrepancyApi | discrepancyGetDiscrepancyAnalyses | GET /api/v4/Discrepancy/analyses | Get detailed discrepancy analyses with filtering and pagination V4DiscrepancyApi | discrepancyGetDiscrepancyAnalysis | GET /api/v4/Discrepancy/analyses/{id} | Get a specific discrepancy analysis by ID V4DiscrepancyApi | discrepancyGetEndpointMetrics | GET /api/v4/Discrepancy/endpoints | Get per-endpoint compatibility metrics V4DiscrepancyApi | discrepancyIngestDiscrepancy | POST /api/v4/Discrepancy/ingest | Receive forwarded discrepancies from remote Nocturne instances V4FoodsApi | foodsAddFavorite | POST /api/v4/foods/{foodId}/favorite | Add a food to favorites. V4FoodsApi | foodsDeleteFood | DELETE /api/v4/foods/{foodId} | Delete a food from the database, handling any meal attributions that reference it. V4FoodsApi | foodsGetFavorites | GET /api/v4/foods/favorites | Get current user's favorite foods. V4FoodsApi | foodsGetFoodAttributionCount | GET /api/v4/foods/{foodId}/attribution-count | Get how many meal attributions reference a specific food. V4FoodsApi | foodsGetRecentFoods | GET /api/v4/foods/recent | Get recently used foods (excluding favorites). V4FoodsApi | foodsRemoveFavorite | DELETE /api/v4/foods/{foodId}/favorite | Remove a food from favorites. V4HeartRateApi | heartRateCreateHeartRates | POST /api/v4/HeartRate | Create one or more heart rate records (single object or array) V4HeartRateApi | heartRateDeleteHeartRate | DELETE /api/v4/HeartRate/{id} | Delete a heart rate record by ID V4HeartRateApi | heartRateGetHeartRate | GET /api/v4/HeartRate/{id} | Get a specific heart rate record by ID V4HeartRateApi | heartRateGetHeartRates | GET /api/v4/HeartRate | Get heart rate records with optional pagination V4HeartRateApi | heartRateUpdateHeartRate | PUT /api/v4/HeartRate/{id} | Update an existing heart rate record V4InsulinsApi | insulinCatalogGetCatalog | GET /api/v4/insulins/catalog | Get all known insulin formulations. V4InsulinsApi | insulinCatalogGetCatalogByCategory | GET /api/v4/insulins/catalog/{category} | Get insulin formulations filtered by category. V4MealMatchingApi | mealMatchingAcceptMatch | POST /api/v4/meal-matching/accept | Accept a meal match V4MealMatchingApi | mealMatchingDismissMatch | POST /api/v4/meal-matching/dismiss | Dismiss a meal match V4MealMatchingApi | mealMatchingGetFoodEntry | GET /api/v4/meal-matching/food-entries/{id} | Get a food entry for review V4MealMatchingApi | mealMatchingGetSuggestions | GET /api/v4/meal-matching/suggestions | Get suggested meal matches for a date range V4MeterGlucoseApi | meterGlucoseCreate | POST /api/v4/glucose/meter | V4MeterGlucoseApi | meterGlucoseDelete | DELETE /api/v4/glucose/meter/{id} | V4MeterGlucoseApi | meterGlucoseGetAll | GET /api/v4/glucose/meter | V4MeterGlucoseApi | meterGlucoseGetById | GET /api/v4/glucose/meter/{id} | V4MeterGlucoseApi | meterGlucoseUpdate | PUT /api/v4/glucose/meter/{id} | V4NotesApi | noteCreate | POST /api/v4/observations/notes | V4NotesApi | noteDelete | DELETE /api/v4/observations/notes/{id} | V4NotesApi | noteGetAll | GET /api/v4/observations/notes | V4NotesApi | noteGetById | GET /api/v4/observations/notes/{id} | V4NotesApi | noteUpdate | PUT /api/v4/observations/notes/{id} | V4NotificationsApi | notificationsDismissNotification | DELETE /api/v4/notifications/{id} | Dismiss a notification (archive with dismissed reason) V4NotificationsApi | notificationsExecuteAction | POST /api/v4/notifications/{id}/actions/{actionId} | Execute an action on a notification V4NotificationsApi | notificationsGetNotifications | GET /api/v4/notifications | Get all active notifications for the current user V4NutritionApi | nutritionAddCarbIntakeFood | POST /api/v4/nutrition/carbs/{id}/foods | Add a food breakdown entry to a carb intake record. V4NutritionApi | nutritionCreateCarbIntake | POST /api/v4/nutrition/carbs | Create a new carb intake V4NutritionApi | nutritionDeleteCarbIntake | DELETE /api/v4/nutrition/carbs/{id} | Delete a carb intake V4NutritionApi | nutritionDeleteCarbIntakeFood | DELETE /api/v4/nutrition/carbs/{id}/foods/{foodEntryId} | Remove a food breakdown entry. V4NutritionApi | nutritionGetCarbIntakeById | GET /api/v4/nutrition/carbs/{id} | Get a carb intake by ID V4NutritionApi | nutritionGetCarbIntakeFoods | GET /api/v4/nutrition/carbs/{id}/foods | Get food breakdown for a carb intake record. V4NutritionApi | nutritionGetCarbIntakes | GET /api/v4/nutrition/carbs | Get carb intakes with optional filtering V4NutritionApi | nutritionGetMeals | GET /api/v4/nutrition/meals | Get carb intake records with food attribution status for the meals view. V4NutritionApi | nutritionUpdateCarbIntake | PUT /api/v4/nutrition/carbs/{id} | Update an existing carb intake V4NutritionApi | nutritionUpdateCarbIntakeFood | PUT /api/v4/nutrition/carbs/{id}/foods/{foodEntryId} | Update a food breakdown entry. V4PatientRecordApi | patientRecordCreateDevice | POST /api/v4/patient-record/devices | Create a new patient device V4PatientRecordApi | patientRecordCreateInsulin | POST /api/v4/patient-record/insulins | Create a new patient insulin V4PatientRecordApi | patientRecordDeleteDevice | DELETE /api/v4/patient-record/devices/{id} | Delete a patient device V4PatientRecordApi | patientRecordDeleteInsulin | DELETE /api/v4/patient-record/insulins/{id} | Delete a patient insulin V4PatientRecordApi | patientRecordGetDevices | GET /api/v4/patient-record/devices | Get all patient devices V4PatientRecordApi | patientRecordGetInsulins | GET /api/v4/patient-record/insulins | Get all patient insulins V4PatientRecordApi | patientRecordGetPatientRecord | GET /api/v4/patient-record | Get or create the patient record V4PatientRecordApi | patientRecordUpdateDevice | PUT /api/v4/patient-record/devices/{id} | Update a patient device V4PatientRecordApi | patientRecordUpdateInsulin | PUT /api/v4/patient-record/insulins/{id} | Update a patient insulin V4PatientRecordApi | patientRecordUpdatePatientRecord | PUT /api/v4/patient-record | Update the patient record V4PredictionsApi | predictionGetPredictions | GET /api/v4/predictions | Get glucose predictions based on current data. Returns predicted glucose values for the next 4 hours in 5-minute intervals. V4PredictionsApi | predictionGetStatus | GET /api/v4/predictions/status | Check the status of the prediction service. V4ProcessingApi | processingGetProcessingStatus | GET /api/v4/processing/status/{correlationId} | Get the processing status for a correlation ID V4ProcessingApi | processingWaitForCompletion | GET /api/v4/processing/status/{correlationId}/wait | Wait for processing to complete with long polling V4ProfileApi | profileCreateBasalSchedule | POST /api/v4/profile/basal | Create a new basal schedule V4ProfileApi | profileCreateCarbRatioSchedule | POST /api/v4/profile/carb-ratio | Create a new carb ratio schedule V4ProfileApi | profileCreateSensitivitySchedule | POST /api/v4/profile/sensitivity | Create a new sensitivity schedule V4ProfileApi | profileCreateTargetRangeSchedule | POST /api/v4/profile/target-range | Create a new target range schedule V4ProfileApi | profileCreateTherapySettings | POST /api/v4/profile/settings | Create a new therapy settings record V4ProfileApi | profileDeleteBasalSchedule | DELETE /api/v4/profile/basal/{id} | Delete a basal schedule V4ProfileApi | profileDeleteCarbRatioSchedule | DELETE /api/v4/profile/carb-ratio/{id} | Delete a carb ratio schedule V4ProfileApi | profileDeleteSensitivitySchedule | DELETE /api/v4/profile/sensitivity/{id} | Delete a sensitivity schedule V4ProfileApi | profileDeleteTargetRangeSchedule | DELETE /api/v4/profile/target-range/{id} | Delete a target range schedule V4ProfileApi | profileDeleteTherapySettings | DELETE /api/v4/profile/settings/{id} | Delete a therapy settings record V4ProfileApi | profileGetBasalScheduleById | GET /api/v4/profile/basal/by-id/{id} | Get a basal schedule by ID V4ProfileApi | profileGetBasalSchedulesByName | GET /api/v4/profile/basal/{profileName} | Get basal schedules by profile name V4ProfileApi | profileGetCarbRatioScheduleById | GET /api/v4/profile/carb-ratio/by-id/{id} | Get a carb ratio schedule by ID V4ProfileApi | profileGetCarbRatioSchedulesByName | GET /api/v4/profile/carb-ratio/{profileName} | Get carb ratio schedules by profile name V4ProfileApi | profileGetProfileSummary | 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. V4ProfileApi | profileGetSensitivityScheduleById | GET /api/v4/profile/sensitivity/by-id/{id} | Get a sensitivity schedule by ID V4ProfileApi | profileGetSensitivitySchedulesByName | GET /api/v4/profile/sensitivity/{profileName} | Get sensitivity schedules by profile name V4ProfileApi | profileGetTargetRangeScheduleById | GET /api/v4/profile/target-range/by-id/{id} | Get a target range schedule by ID V4ProfileApi | profileGetTargetRangeSchedulesByName | GET /api/v4/profile/target-range/{profileName} | Get target range schedules by profile name V4ProfileApi | profileGetTherapySettings | GET /api/v4/profile/settings | Get all therapy settings with optional filtering V4ProfileApi | profileGetTherapySettingsById | GET /api/v4/profile/settings/{id} | Get a therapy settings record by ID V4ProfileApi | profileGetTherapySettingsByName | GET /api/v4/profile/settings/by-name/{profileName} | Get therapy settings by profile name V4ProfileApi | profileUpdateBasalSchedule | PUT /api/v4/profile/basal/{id} | Update an existing basal schedule V4ProfileApi | profileUpdateCarbRatioSchedule | PUT /api/v4/profile/carb-ratio/{id} | Update an existing carb ratio schedule V4ProfileApi | profileUpdateSensitivitySchedule | PUT /api/v4/profile/sensitivity/{id} | Update an existing sensitivity schedule V4ProfileApi | profileUpdateTargetRangeSchedule | PUT /api/v4/profile/target-range/{id} | Update an existing target range schedule V4ProfileApi | profileUpdateTherapySettings | PUT /api/v4/profile/settings/{id} | Update an existing therapy settings record V4PumpSnapshotsApi | pumpSnapshotGetAll | GET /api/v4/device-status/pump | V4PumpSnapshotsApi | pumpSnapshotGetById | GET /api/v4/device-status/pump/{id} | V4RetrospectiveApi | retrospectiveGetBasalTimeline | GET /api/v4/Retrospective/basal-timeline | Get basal rate timeline for a day Returns basal rate data points showing scheduled and temp basal changes V4RetrospectiveApi | retrospectiveGetRetrospectiveData | GET /api/v4/Retrospective/at | Get retrospective data at a specific point in time Returns IOB, COB, glucose, basal rate, and recent treatments V4RetrospectiveApi | retrospectiveGetRetrospectiveTimeline | 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 V4SensorGlucoseApi | sensorGlucoseCreate | POST /api/v4/glucose/sensor | V4SensorGlucoseApi | sensorGlucoseDelete | DELETE /api/v4/glucose/sensor/{id} | V4SensorGlucoseApi | sensorGlucoseGetAll | GET /api/v4/glucose/sensor | V4SensorGlucoseApi | sensorGlucoseGetById | GET /api/v4/glucose/sensor/{id} | V4SensorGlucoseApi | sensorGlucoseUpdate | PUT /api/v4/glucose/sensor/{id} | V4ServicesApi | servicesDeleteConnectorData | DELETE /api/v4/services/connectors/{id}/data | Delete all data from a specific connector. WARNING: This is a destructive operation that cannot be undone. V4ServicesApi | servicesDeleteDataSourceData | 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. V4ServicesApi | servicesDeleteDemoData | DELETE /api/v4/services/data-sources/demo | Delete all demo data. This operation is safe as demo data can be easily regenerated. V4ServicesApi | servicesGetActiveDataSources | 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. V4ServicesApi | servicesGetApiInfo | 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. V4ServicesApi | servicesGetAvailableConnectors | GET /api/v4/services/connectors | Get available connectors that can be configured to pull data into Nocturne. V4ServicesApi | servicesGetConnectorCapabilities | GET /api/v4/services/connectors/{id}/capabilities | Get capabilities for a specific connector. V4ServicesApi | servicesGetConnectorDataSummary | 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. V4ServicesApi | servicesGetConnectorSyncStatus | 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. V4ServicesApi | servicesGetDataSource | GET /api/v4/services/data-sources/{id} | Get detailed information about a specific data source. V4ServicesApi | servicesGetServicesOverview | GET /api/v4/services | Get a complete overview of services, data sources, and available integrations. V4ServicesApi | servicesGetUploaderApps | GET /api/v4/services/uploaders | Get uploader apps that can push data to Nocturne with setup instructions. V4ServicesApi | servicesGetUploaderSetup | GET /api/v4/services/uploaders/{appId}/setup | Get setup instructions for a specific uploader app. V4ServicesApi | servicesTriggerConnectorSync | POST /api/v4/services/connectors/{id}/sync | Trigger a manual sync for a specific connector. V4StepCountApi | stepCountCreateStepCounts | POST /api/v4/StepCount | Create one or more step count records (single object or array) V4StepCountApi | stepCountDeleteStepCount | DELETE /api/v4/StepCount/{id} | Delete a step count record by ID V4StepCountApi | stepCountGetStepCount | GET /api/v4/StepCount/{id} | Get a specific step count record by ID V4StepCountApi | stepCountGetStepCounts | GET /api/v4/StepCount | Get step count records with optional pagination V4StepCountApi | stepCountUpdateStepCount | PUT /api/v4/StepCount/{id} | Update an existing step count record V4SystemApi | systemHeartbeat | POST /api/v4/system/heartbeat | Accept a heartbeat from an external service (e.g. bot adapter). Returns 200 OK. Actual health tracking will be added later. V4TrackerAlertsApi | trackerAlertsGetAvailableSounds | GET /api/v4/trackers/alerts/sounds | Get available alert sounds V4TrackerAlertsApi | trackerAlertsGetPendingAlerts | GET /api/v4/trackers/alerts/pending | Get pending tracker alerts for the current user V4TrackersApi | trackersAckInstance | POST /api/v4/trackers/instances/{id}/ack | Acknowledge/snooze a tracker notification V4TrackersApi | trackersApplyPreset | POST /api/v4/trackers/presets/{id}/apply | Apply a preset (starts a new instance) V4TrackersApi | trackersCompleteInstance | PUT /api/v4/trackers/instances/{id}/complete | Complete a tracker instance V4TrackersApi | trackersCreateDefinition | POST /api/v4/trackers/definitions | Create a new tracker definition V4TrackersApi | trackersCreatePreset | POST /api/v4/trackers/presets | Create a new preset V4TrackersApi | trackersDeleteDefinition | DELETE /api/v4/trackers/definitions/{id} | Delete a tracker definition V4TrackersApi | trackersDeleteInstance | DELETE /api/v4/trackers/instances/{id} | Delete a tracker instance V4TrackersApi | trackersDeletePreset | DELETE /api/v4/trackers/presets/{id} | Delete a preset V4TrackersApi | trackersGetActiveInstances | GET /api/v4/trackers/instances | Get active tracker instances V4TrackersApi | trackersGetDefinition | GET /api/v4/trackers/definitions/{id} | Get a specific tracker definition V4TrackersApi | trackersGetDefinitions | GET /api/v4/trackers/definitions | Get all tracker definitions. Returns public trackers for unauthenticated users, or all visible trackers for authenticated users. V4TrackersApi | trackersGetInstanceHistory | GET /api/v4/trackers/instances/history | Get completed tracker instances (history) V4TrackersApi | trackersGetPresets | GET /api/v4/trackers/presets | Get all presets for the current user V4TrackersApi | trackersGetUpcomingInstances | GET /api/v4/trackers/instances/upcoming | Get upcoming tracker expirations for calendar V4TrackersApi | trackersStartInstance | POST /api/v4/trackers/instances | Start a new tracker instance V4TrackersApi | trackersUpdateDefinition | PUT /api/v4/trackers/definitions/{id} | Update a tracker definition V4TreatmentsApi | treatmentsCreateTreatment | POST /api/v4/treatments | Create a treatment with tracker integration. If the treatment's event type matches a tracker's trigger event types, the tracker instance will be automatically started/restarted. V4TreatmentsApi | treatmentsCreateTreatments | POST /api/v4/treatments/bulk | Create multiple treatments with tracker integration. V4TreatmentsApi | treatmentsDeleteTreatment | DELETE /api/v4/treatments/{id} | Delete a treatment by ID V4TreatmentsApi | treatmentsGetTreatment | GET /api/v4/treatments/{id} | Get a specific treatment by ID V4TreatmentsApi | treatmentsGetTreatments | GET /api/v4/treatments | Get treatments with optional filtering and pagination. Unlike V1-V3 endpoints, this does NOT include StateSpan-derived basal data. For basal delivery, query /api/v4/state-spans?category=BasalDelivery instead. V4TreatmentsApi | treatmentsUpdateTreatment | PUT /api/v4/treatments/{id} | Update an existing treatment by ID V4UploaderSnapshotsApi | uploaderSnapshotGetAll | GET /api/v4/device-status/uploader | V4UploaderSnapshotsApi | uploaderSnapshotGetById | GET /api/v4/device-status/uploader/{id} | WebhookSettingsApi | webhookSettingsGetWebhookSettings | GET /api/v4/ui-settings/notifications/webhooks | WebhookSettingsApi | webhookSettingsSaveWebhookSettings | PUT /api/v4/ui-settings/notifications/webhooks | WebhookSettingsApi | webhookSettingsTestWebhookSettings | POST /api/v4/ui-settings/notifications/webhooks/test |

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@nightscoutfoundation/[email protected]

Usage

Documentation

API Endpoints

Models