Skip to content

Get information from N.I.N.A.

rennmaus-coder edited this page Aug 7, 2024 · 1 revision

Profile ("api/profile"):

URL parameters (property):

  • active (returns full information about the active profile with all settings)
  • all (returns information to needed to load a different profile)
Examples
Sample calls Sample Response
property=all
{
  "Response": [
    {
      "Name": "Samyang 135mm",
      "IsActive": false,
      "Id": "4c12df08-d16a-4156-a545-4bb6cde1c237",
      "Location": "C:\\Users\\<Username>\\AppData\\Local\\NINA\\Profiles\\4c12df08-d16a-4156-a545-4bb6cde1c237.profile",
      "LastUsed": "2024-08-05T14:11:43.0232093+02:00",
      "Description": ""
    },
    {
      "Name": "Canon 50mm",
      "IsActive": false,
      "Id": "680d2074-cadf-4354-8157-e021f7d031d1",
      "Location": "C:\\Users\\<Username>\\AppData\\Local\\NINA\\Profiles\\680d2074-cadf-4354-8157-e021f7d031d1.profile",
      "LastUsed": "2024-08-05T14:09:12.5846136+02:00",
      "Description": ""
    },
    {
      "Name": "Test",
      "IsActive": false,
      "Id": "d91bdc56-b2cd-4b05-948f-e19de36f3674",
      "Location": "C:\\Users\\<Username>\\AppData\\Local\\NINA\\Profiles\\d91bdc56-b2cd-4b05-948f-e19de36f3674.profile",
      "LastUsed": "2024-08-05T13:56:32.2099052+02:00",
      "Description": ""
    },
    {
      "Name": "Default-2024-08-06T12:00:27",
      "IsActive": true,
      "Id": "7f4afdbc-ce37-43b5-98a2-d6063829dce1",
      "Location": "C:\\Users\\<Username>\\AppData\\Local\\NINA\\Profiles\\7f4afdbc-ce37-43b5-98a2-d6063829dce1.profile",
      "LastUsed": "0001-01-01T00:00:00",
      "Description": null
    }
  ],
  "Error": "",
  "Success": true,
  "Type": "API"
}
property=active
{
  "Response": {
    "Id": "7f4afdbc-ce37-43b5-98a2-d6063829dce1",
    "LastUsed": "2024-08-06T12:00:28.8968579+02:00",
    "Name": "Default-2024-08-06T12:00:27",
    "Description": "",
    "ApplicationSettings": {
      "Culture": "en-GB",
      "LogLevel": 2,
      "DevicePollingInterval": 2,
      "SkyAtlasImageRepository": "",
      "SkySurveyCacheDirectory": "C:\\Users\\<Username>\\AppData\\Local\\NINA\\FramingAssistantCache",
      "SelectedPluggableBehaviors": [],
      "PageSize": 50
    },
    "AstrometrySettings": {
      "Latitude": 0,
      "Longitude": 0,
      "Elevation": 0,
      "HorizonFilePath": ""
    },
    "CameraSettings": {
      "Id": "No_Device",
      "PixelSize": 3.8,
      "BayerPattern": 0,
      "BulbMode": 0,
      "SerialPort": "COM1",
      "BitDepth": 16,
      "RawConverter": 1,
      "MinFlatExposureTime": 0.2,
      "MaxFlatExposureTime": 20,
      "FileCameraFolder": "",
      "FileCameraExtension": null,
      "FileCameraUseBulbMode": false,
      "FileCameraIsBayered": false,
      "FLIEnableFloodFlush": false,
      "FLIFloodDuration": 1,
      "FLIFlushCount": 2,
      "FLIFloodBin": null,
      "FLIEnableSnapshotFloodFlush": false,
      "BitScaling": true,
      "CoolingDuration": 0,
      "WarmingDuration": 0,
      "Temperature": null,
      "BinningX": null,
      "BinningY": null,
      "Gain": null,
      "Offset": null,
      "USBLimit": null,
      "ReadoutMode": null,
      "ReadoutModeForSnapImages": null,
      "ReadoutModeForNormalImages": null,
      "QhyIncludeOverscan": false,
      "Timeout": 60,
      "DewHeaterOn": false,
      "ASCOMAllowUnevenPixelDimension": true,
      "MirrorLockupDelay": 0,
      "AtikGainPreset": 0,
      "AtikExposureSpeed": 0,
      "AtikWindowHeaterPowerLevel": 0,
      "BinAverageEnabled": false,
      "TrackingCameraASCOMServerEnabled": false,
      "TrackingCameraASCOMServerPipeName": "NINA.ASCOM.Camera.SBIG.Tracker",
      "FileCameraAlwaysListen": false,
      "FileCameraDownloadDelay": 0,
      "SBIGUseExternalCcdTracker": false,
      "TrackingCameraASCOMServerLoggingEnabled": false,
      "ZwoAsiMonoBinMode": false,
      "ASCOMCreate32BitData": false,
      "GenericCameraDewHeaterStrength": 10,
      "GenericCameraFanSpeed": 70,
      "BadPixelCorrection": true,
      "BadPixelCorrectionThreshold": 60,
      "TouptekAlikeUltraMode": true,
      "TouptekAlikeHighFullwell": false,
      "TouptekAlikeDewHeaterStrength": -1,
      "TouptekAlikeLEDLights": true
    },
    "ColorSchemaSettings": {
      "AltColorSchema": {
        "Name": "Dark",
        "PrimaryColor": "#FF550C18",
        "SecondaryColor": "#FF1B2A41",
        "BorderColor": "#FF550C18",
        "BackgroundColor": "#FF02010A",
        "SecondaryBackgroundColor": "#FF230409",
        "TertiaryBackgroundColor": "#FF2D060D",
        "ButtonBackgroundColor": "#FF550C18",
        "ButtonBackgroundSelectedColor": "#FF96031A",
        "ButtonForegroundColor": "#FF02010A",
        "ButtonForegroundDisabledColor": "#FF443730",
        "NotificationWarningColor": "#FF5E330B",
        "NotificationErrorColor": "#FF700000",
        "NotificationWarningTextColor": "#FF02010A",
        "NotificationErrorTextColor": "#FF02010A"
      },
      "ColorSchema": {
        "Name": "Persian Faint",
        "PrimaryColor": "#FFBDC3C7",
        "SecondaryColor": "#FF1D2731",
        "BorderColor": "#AA3F4141",
        "BackgroundColor": "#FF263238",
        "SecondaryBackgroundColor": "#FF2A2C31",
        "TertiaryBackgroundColor": "#FF2C3438",
        "ButtonBackgroundColor": "#FF007063",
        "ButtonBackgroundSelectedColor": "#FF00BCA6",
        "ButtonForegroundColor": "#FFFFFFFF",
        "ButtonForegroundDisabledColor": "#FF9E9E9E",
        "NotificationWarningColor": "#FF5E330B",
        "NotificationErrorColor": "#FF700000",
        "NotificationWarningTextColor": "#FFBDC3C7",
        "NotificationErrorTextColor": "#FFBDC3C7"
      }
    },
    "DomeSettings": {
      "Id": "No_Device",
      "ScopePositionEastWest_mm": 0,
      "ScopePositionNorthSouth_mm": 0,
      "ScopePositionUpDown_mm": 0,
      "DomeRadius_mm": 0,
      "GemAxis_mm": 0,
      "LateralAxis_mm": 0,
      "AzimuthTolerance_degrees": 2,
      "FindHomeBeforePark": false,
      "DomeSyncTimeoutSeconds": 120,
      "SynchronizeDuringMountSlew": false,
      "SyncSlewDomeWhenMountSlews": false,
      "RotateDegrees": 10,
      "CloseOnUnsafe": false,
      "ParkMountBeforeShutterMove": false,
      "RefuseUnsafeShutterMove": false,
      "RefuseUnsafeShutterOpenSansSafetyDevice": false,
      "ParkDomeBeforeShutterMove": false,
      "MountType": 0,
      "DecOffsetHorizontal_mm": 0,
      "SettleTimeSeconds": 1
    },
    "FilterWheelSettings": {
      "Id": "No_Device",
      "DisableGuidingOnFilterChange": false,
      "Unidirectional": false,
      "FilterWheelFilters": []
    },
    "FocuserSettings": {
      "Id": "No_Device",
      "UseFilterWheelOffsets": false,
      "AutoFocusStepSize": 50,
      "AutoFocusInitialOffsetSteps": 4,
      "AutoFocusExposureTime": 4,
      "AutoFocusMethod": 0,
      "ContrastDetectionMethod": 2,
      "AutoFocusDisableGuiding": false,
      "FocuserSettleTime": 0,
      "AutoFocusTotalNumberOfAttempts": 1,
      "AutoFocusNumberOfFramesPerPoint": 1,
      "AutoFocusInnerCropRatio": 1,
      "AutoFocusOuterCropRatio": 1,
      "BacklashIn": 0,
      "BacklashOut": 0,
      "AutoFocusBinning": 1,
      "AutoFocusUseBrightestStars": 0,
      "AutoFocusCurveFitting": 3,
      "BacklashCompensationModel": 1,
      "AutoFocusTimeoutSeconds": 600,
      "RSquaredThreshold": 0.7
    },
    "FramingAssistantSettings": {
      "LastSelectedImageSource": 4,
      "CameraHeight": 3500,
      "CameraWidth": 4500,
      "FieldOfView": 3,
      "Opacity": 0.2,
      "LastRotationAngle": 0,
      "SaveImageInOfflineCache": false
    },
    "GuiderSettings": {
      "DitherPixels": 5,
      "DitherRAOnly": false,
      "SettleTime": 10,
      "PHD2InstanceNumber": 1,
      "PHD2ServerUrl": "localhost",
      "PHD2ServerPort": 4400,
      "PHD2HistorySize": 100,
      "PHD2Path": "C:\\Program Files (x86)\\PHDGuiding2\\phd2.exe",
      "PHD2GuiderScale": 0,
      "SettlePixels": 1.5,
      "SettleTimeout": 40,
      "GuiderName": "PHD2",
      "AutoRetryStartGuiding": false,
      "AutoRetryStartGuidingTimeoutSeconds": 300,
      "MaxY": 4,
      "MetaGuideUseIpAddressAny": false,
      "MetaGuidePort": 1277,
      "MGENFocalLength": 1000,
      "MGENPixelMargin": 10,
      "MetaGuideMinIntensity": 100,
      "MetaGuideDitherSettleSeconds": 30,
      "MetaGuideLockWhenGuiding": false,
      "PHD2ROIPct": 100,
      "PHD2ProfileId": null,
      "SkyGuardServerUrl": "localhost",
      "SkyGuardServerPort": 18700,
      "SkyGuardPath": "",
      "SkyGuardCallbackPort": 8000,
      "SkyGuardTimeLapsChecked": false,
      "SkyGuardValueMaxGuiding": 1,
      "SkyGuardTimeLapsGuiding": 60,
      "SkyGuardTimeLapsDitherChecked": false,
      "SkyGuardValueMaxDithering": 1,
      "SkyGuardTimeLapsDithering": 60,
      "SkyGuardTimeOutGuiding": 5,
      "GuideChartRightAscensionColor": "#FF0000FF",
      "GuideChartDeclinationColor": "#FFFF0000",
      "GuideChartShowCorrections": true
    },
    "ImageFileSettings": {
      "FilePath": "C:\\Users\\<Username>\\Documents\\N.I.N.A",
      "FilePattern": "$$DATEMINUS12$$\\$$IMAGETYPE$$\\$$DATETIME$$_$$FILTER$$_$$SENSORTEMP$$_$$EXPOSURETIME$$s_$$FRAMENR$$",
      "FilePatternDARK": "",
      "FilePatternFLAT": "",
      "FilePatternBIAS": "",
      "FileType": 1,
      "TIFFCompressionType": 0,
      "XISFCompressionType": 0,
      "XISFChecksumType": 2,
      "XISFByteShuffling": false,
      "FITSCompressionType": 0,
      "FITSAddFzExtension": true,
      "FITSUseLegacyWriter": true
    },
    "ImageSettings": {
      "AutoStretchFactor": 0.2,
      "BlackClipping": -2.8,
      "AnnotateImage": false,
      "DebayerImage": true,
      "DebayeredHFR": true,
      "UnlinkedStretch": true,
      "AnnotateUnlimitedStars": false,
      "StarSensitivity": 1,
      "NoiseReduction": 0,
      "SharpCapSensorAnalysisFolder": null,
      "DetectStars": true,
      "AutoStretch": true
    },
    "MeridianFlipSettings": {
      "Recenter": true,
      "MinutesAfterMeridian": 5,
      "MaxMinutesAfterMeridian": 10,
      "UseSideOfPier": true,
      "SettleTime": 30,
      "PauseTimeBeforeMeridian": 0,
      "AutoFocusAfterFlip": false,
      "RotateImageAfterFlip": false
    },
    "PlateSolveSettings": {
      "PlateSolverType": 5,
      "BlindSolverType": 3,
      "AstrometryURL": "http://nova.astrometry.net",
      "AstrometryAPIKey": "",
      "CygwinLocation": "",
      "SearchRadius": 30,
      "PS2Location": "",
      "PS3Location": "",
      "Regions": 5000,
      "ExposureTime": 2,
      "Threshold": 1,
      "RotationTolerance": 1,
      "NumberOfAttempts": 10,
      "ReattemptDelay": 2,
      "Filter": null,
      "AspsLocation": "C:\\Program Files\\astap\\astap.exe",
      "ASTAPLocation": "C:\\Program Files\\astap\\astap.exe",
      "DownSampleFactor": 0,
      "MaxObjects": 500,
      "Sync": false,
      "SlewToTarget": false,
      "Binning": 1,
      "Gain": -1,
      "BlindFailoverEnabled": true,
      "TheSkyXHost": "localhost",
      "TheSkyXPort": 3040,
      "PinPointCatalogType": 3,
      "PinPointCatalogRoot": "C:\\GSC11\\",
      "PinPointMaxMagnitude": 20,
      "PinPointExpansion": 40,
      "PinPointAllSkyApiKey": "",
      "PinPointAllSkyApiHost": "nova.astrometry.net"
    },
    "RotatorSettings": {
      "Id": "No_Device",
      "Reverse": true,
      "Reverse2": false,
      "RangeType": 0,
      "RangeStartMechanicalPosition": 0
    },
    "FlatDeviceSettings": {
      "Id": "No_Device",
      "Name": null,
      "PortName": null,
      "SettleTime": 0,
      "FilterSettings": {},
      "TrainedFlatExposureSettings": []
    },
    "SequenceSettings": {
      "TemplatePath": "",
      "ParkMountAtSequenceEnd": false,
      "CloseDomeShutterAtSequenceEnd": true,
      "ParkDomeAtSequenceEnd": true,
      "WarmCamAtSequenceEnd": false,
      "TimeSpanInTicks": 0,
      "DefaultSequenceFolder": "C:\\Users\\<Username>\\Documents\\N.I.N.A",
      "SequenceCompleteCommand": null,
      "SequencerTemplatesFolder": "C:\\Users\\<Username>\\Documents\\N.I.N.A\\Templates",
      "SequencerTargetsFolder": "C:\\Users\\<Username>\\Documents\\N.I.N.A\\Targets",
      "StartupSequenceTemplate": "",
      "CoolCameraAtSequenceStart": false,
      "UnparMountAtSequenceStart": true,
      "OpenDomeShutterAtSequenceStart": false,
      "CollapseSequencerTemplatesByDefault": false,
      "DoMeridianFlip": false,
      "DisableSimpleSequencer": false
    },
    "SwitchSettings": {
      "Id": "No_Device"
    },
    "TelescopeSettings": {
      "Id": "No_Device",
      "Name": "",
      "MountName": "",
      "FocalLength": "NaN",
      "FocalRatio": "NaN",
      "SnapPortStart": ":SNAP1,1#",
      "SnapPortStop": "SNAP1,0#",
      "SettleTime": 5,
      "NoSync": false,
      "PrimaryReversed": false,
      "SecondaryReversed": false,
      "TelescopeLocationSyncDirection": 0,
      "TimeSync": true
    },
    "WeatherDataSettings": {
      "Id": "No_Device",
      "OpenWeatherMapAPIKey": "",
      "TheWeatherCompanyAPIKey": "",
      "WeatherUndergroundAPIKey": "",
      "WeatherUndergroundStation": ""
    },
    "FlatWizardSettings": {
      "FlatCount": 10,
      "HistogramMeanTarget": 0.5,
      "HistogramTolerance": 0.1,
      "DarkFlatCount": 0,
      "OpenForDarkFlats": false,
      "AltitudeSite": 0,
      "FlatWizardMode": 0
    },
    "PlanetariumSettings": {
      "StellariumHost": "localhost",
      "StellariumPort": 8090,
      "CdCHost": "localhost",
      "CdCPort": 3292,
      "TSXHost": "localhost",
      "TSXPort": 3040,
      "TSXUseSelectedObject": false,
      "HNSKYHost": "localhost",
      "HNSKYPort": 7700,
      "C2AHost": "localhost",
      "C2APort": 5876,
      "SkytechXHost": "localhost",
      "SkytechXPort": 2055,
      "PreferredPlanetarium": 0
    },
    "SnapShotControlSettings": {
      "Gain": -1,
      "Filter": null,
      "ExposureDuration": 1,
      "Save": false,
      "Loop": false
    },
    "SafetyMonitorSettings": {
      "Id": "No_Device"
    },
    "PluginSettings": {
      "pluginStorage": {
        "0f1d10b6-d306-4168-b751-d454cbac9670": {
          "IntermediateSavePath": "C:\\Users\\<Username>\\AppData\\Local\\NINA\\HocusFocusIntermediate",
          "NoiseReductionRadius": 4
        }
      }
    },
    "GnssSettings": {
      "GnssSource": 0
    },
    "DockPanelSettings": {
      "ShowImagingHistogram": true,
      "CameraInfoOnly": false,
      "FilterWheelInfoOnly": false,
      "FocuserInfoOnly": false,
      "RotatorInfoOnly": false,
      "SwitchInfoOnly": false,
      "FlatDeviceInfoOnly": false
    },
    "AlpacaSettings": {
      "NumberOfPolls": 1,
      "PollInterval": 100,
      "DiscoveryPort": 32227,
      "DiscoveryDuration": 2,
      "ResolveDnsName": false,
      "UseIPv4": true,
      "UseIPv6": false,
      "UseHttps": false
    },
    "ImageHistorySettings": {
      "ImageHistoryLeftSelected": 1,
      "ImageHistoryRightSelected": 2
    }
  },
  "Error": "",
  "Success": true,
  "Type": "API"
}

Imagehistory ("api/history"):

URL parameters:

  • property: count / list (gets information about an image at the specified index) / socket (returns additional information about captured images)
  • parameter: any integer (the index of the ImageHistoryPoint, -1 for all)

list doesn't include gain and exposureTime, but socket does

Examples
Sample calls Sample Response
property=count
{
  "Response": {
    "Count": 1
  },
  "Error": "",
  "Success": true,
  "Type": "API"
}
property=list (with specified index via parameter)
{
  "Response": [
    {
      "RmsText": "Tot: 0.00 (0.00\")",
      "RotatorPosition": 0,
      "Mean": 4999.872975260417,
      "MAD": 67,
      "IsBayered": false,
      "Rms": 0,
      "Id": 1,
      "Temperature": 0,
      "TargetName": "",
      "Filter": "",
      "FocuserPosition": 0,
      "Median": 5000,
      "RotatorMechanicalPosition": 0,
      "Type": "LIGHT",
      "StDev": 99.96175243887936,
      "LocalPath": "C:\\Users\\Christian\\Documents\\N.I.N.A\\2024-08-06\\LIGHT\\2024-08-06_12-07-52___0.00s_0000.fits",
      "DateTime": "2024-08-06T12:07:52.9345727+02:00",
      "HFR": 0,
      "Filename": "2024-08-06_12-07-52___0.00s_0000.fits",
      "Stars": 0,
      "Duration": 0,
      "AutoFocusPoint": "null",
      "Index": 1
    }
  ],
  "Error": "",
  "Success": true,
  "Type": "API"
}

or using parameter=-1

{
  "Response": [
    {
      "RmsText": "Tot: 0.00 (0.00\")",
      "RotatorPosition": 0,
      "Mean": 4999.872975260417,
      "MAD": 67,
      "IsBayered": false,
      "Rms": 0,
      "Id": 1,
      "Temperature": 0,
      "TargetName": "",
      "Filter": "",
      "FocuserPosition": 0,
      "Median": 5000,
      "RotatorMechanicalPosition": 0,
      "Type": "LIGHT",
      "StDev": 99.96175243887936,
      "LocalPath": "C:\\Users\\Christian\\Documents\\N.I.N.A\\2024-08-06\\LIGHT\\2024-08-06_12-07-52___0.00s_0000.fits",
      "DateTime": "2024-08-06T12:07:52.9345727+02:00",
      "HFR": 0,
      "Filename": "2024-08-06_12-07-52___0.00s_0000.fits",
      "Stars": 0,
      "Duration": 0,
      "AutoFocusPoint": "null",
      "Index": 1
    },
    {
      "RmsText": "Tot: 0.00 (0.00\")",
      "RotatorPosition": 0,
      "Mean": 4999.4578125,
      "MAD": 68,
      "IsBayered": false,
      "Rms": 0,
      "Id": 2,
      "Temperature": 0,
      "TargetName": "",
      "Filter": "",
      "FocuserPosition": 0,
      "Median": 5000,
      "RotatorMechanicalPosition": 0,
      "Type": "LIGHT",
      "StDev": 100.05050494238027,
      "LocalPath": "C:\\Users\\Christian\\Documents\\N.I.N.A\\2024-08-06\\LIGHT\\2024-08-06_12-13-03___0.00s_0001.fits",
      "DateTime": "2024-08-06T12:13:03.2573822+02:00",
      "HFR": 0,
      "Filename": "2024-08-06_12-13-03___0.00s_0001.fits",
      "Stars": 0,
      "Duration": 0,
      "AutoFocusPoint": "null",
      "Index": 2
    }
  ],
  "Error": "",
  "Success": true,
  "Type": "API"
}
property=socket
{
  "Response": [
    {
      "Event": "IMAGE-SAVE",
      "ExposureTime": 0,
      "Index": 0,
      "Filter": "",
      "RmsText": "Tot: 0.00 (0.00\")",
      "Temperature": "NaN",
      "CameraName": "N.I.N.A. Simulator Camera",
      "Gain": 0,
      "Offset": -1,
      "Date": "2024-08-06T12:42:19.5791274+02:00",
      "TelescopeName": "Canon 100-400mm",
      "FocalLength": 400,
      "StDev": 99.80919695064881,
      "Mean": 4999.868818359375,
      "Median": 5000,
      "Stars": 0,
      "HFR": 0
    }
  ],
  "Error": "",
  "Success": true,
  "Type": "API"
}

Sequence ("api/sequence"):

URL parameters:

  • property: list (returns the currently running sequence)
Examples
Sample calls Sample Response
property=list
{
  "Response": {
    "Strategy": {},
    "Name": "Sample",
    "Conditions": [],
    "IsExpanded": true,
    "Items": [
      {
        "Strategy": {},
        "Name": "Start",
        "Conditions": [],
        "IsExpanded": true,
        "Items": [
          {
            "ErrorBehavior": 0,
            "Attempts": 1
          }
        ],
        "Triggers": [],
        "ErrorBehavior": 0,
        "Attempts": 1
      },
      {
        "Strategy": {},
        "Name": "Targets",
        "Conditions": [],
        "IsExpanded": true,
        "Items": [
          {
            "Target": {
              "Expanded": true,
              "TargetName": null,
              "PositionAngle": 0,
              "InputCoordinates": {
                "RAHours": 0,
                "RAMinutes": 0,
                "RASeconds": 0,
                "NegativeDec": false,
                "DecDegrees": 0,
                "DecMinutes": 0,
                "DecSeconds": 0
              }
            },
            "ExposureInfoListExpanded": false,
            "ExposureInfoList": [],
            "Strategy": {},
            "Name": "Deep Sky Object Instruction Set",
            "Conditions": [],
            "IsExpanded": true,
            "Items": [
              {
                "ExposureTime": 0,
                "Gain": -1,
                "Offset": -1,
                "Binning": {
                  "X": 1,
                  "Y": 1
                },
                "ImageType": "LIGHT",
                "ExposureCount": 0,
                "ErrorBehavior": 0,
                "Attempts": 1
              }
            ],
            "Triggers": [],
            "ErrorBehavior": 0,
            "Attempts": 1
          }
        ],
        "Triggers": [],
        "ErrorBehavior": 0,
        "Attempts": 1
      },
      {
        "Strategy": {},
        "Name": "End",
        "Conditions": [],
        "IsExpanded": true,
        "Items": [
          {
            "ErrorBehavior": 0,
            "Attempts": 1
          }
        ],
        "Triggers": [],
        "ErrorBehavior": 0,
        "Attempts": 1
      }
    ],
    "Triggers": [],
    "ErrorBehavior": 0,
    "Attempts": 1
  },
  "Error": "",
  "Success": true,
  "Type": "API"
}

Equipment ("api/equipment"):

URL parameters:

  • property: camera / telescope / focuser / filterwheel / guider / dome / rotator / safteymonitor / flatdevice / switch / image / thumbnail (same as image but the dimensions are 640x480) / weather
  • parameter: the quality of the image (0-100), -1 for fullsize png
  • index: index of the image in history to return, -1 for latest
Examples
Sample calls Sample Response
property=camera
{
  "Response": {
    "DewHeaterOn": false,
    "SubSampleX": 0,
    "DefaultOffset": 0,
    "GainMax": 10000,
    "CameraState": -1,
    "XSize": 640,
    "LiveViewEnabled": false,
    "CanSubSample": false,
    "SubSampleY": 0,
    "DisplayName": "N.I.N.A. Simulator Camera",
    "ElectronsPerADU": "NaN",
    "GainMin": 0,
    "CoolerOn": false,
    "Gain": 0,
    "Gains": [],
    "OffsetMin": 0,
    "BinX": 1,
    "HasShutter": false,
    "CanSetTemperature": false,
    "ReadoutModes": [
      "Default"
    ],
    "Battery": -1,
    "OffsetMax": 1000,
    "ReadoutModeForNormalImages": 0,
    "DriverVersion": null,
    "CoolerPower": "NaN",
    "PixelSize": 3.8,
    "USBLimit": 0,
    "YSize": 480,
    "DeviceId": "4C0BBF74-0D95-41F6-AAD8-D6D58668CF2C",
    "USBLimitMin": 0,
    "BayerOffsetX": 0,
    "ExposureEndTime": "2024-08-06T12:13:03.2513401+02:00",
    "CanGetGain": true,
    "CanSetUSBLimit": true,
    "SensorType": 0,
    "USBLimitMax": 100,
    "SubSampleWidth": 0,
    "TemperatureSetPoint": "NaN",
    "BinningModes": [
      {
        "X": 1,
        "Y": 1
      }
    ],
    "SupportedActions": [],
    "ReadoutMode": 0,
    "ExposureMax": 1.7976931348623157e+308,
    "Offset": 0,
    "BayerOffsetY": 0,
    "Connected": true,
    "ExposureMin": 0,
    "SubSampleHeight": 0,
    "CanSetGain": true,
    "DefaultGain": 0,
    "IsSubSampleEnabled": false,
    "Temperature": "NaN",
    "LastDownloadTime": 0.0059787,
    "ReadoutModeForSnapImages": 0,
    "Description": null,
    "HasDewHeater": true,
    "CanSetOffset": true,
    "BitDepth": 16,
    "DriverInfo": null,
    "Name": "N.I.N.A. Simulator Camera",
    "IsExposing": false,
    "CanShowLiveView": true,
    "BinY": 1
  },
  "Error": "",
  "Success": true,
  "Type": "API"
}
property=telescope
{
  "Response": {
    "TrackingRate": {
      "TrackingMode": 5,
      "CustomRightAscensionRate": null,
      "CustomDeclinationRate": null
    },
    "IsPulseGuiding": false,
    "SiteLatitude": 49.461799621582,
    "Declination": 1.9445019937538122,
    "GuideRateRightAscensionArcsecPerSec": 15.041068619585433,
    "Description": null,
    "DisplayName": "Simulator",
    "TrackingModes": [
      0,
      1,
      2,
      3,
      4,
      5
    ],
    "AzimuthString": "256° 57' 31\"",
    "HoursToMeridianString": "24:00:00",
    "PrimaryAxisRates": [
      {
        "Item1": 0,
        "Item2": 8
      }
    ],
    "SideOfPier": -1,
    "DriverInfo": null,
    "CanSetPark": true,
    "TargetSideOfPier": null,
    "UTCDate": "2024-08-06T10:18:48.717",
    "Connected": true,
    "CanMovePrimaryAxis": true,
    "AltitudeString": "13° 26' 08\"",
    "GuideRateDeclinationArcsecPerSec": 15.041068619585433,
    "TargetCoordinates": null,
    "CanFindHome": true,
    "Azimuth": 256.958651496096,
    "CanMoveSecondaryAxis": true,
    "SiteLongitude": 8.17236042022705,
    "RightAscensionString": "03:07:27",
    "Slewing": false,
    "SupportedActions": [],
    "CanPulseGuide": true,
    "Coordinates": {
      "RA": 3.1240425363796707,
      "RAString": "03:07:27",
      "RADegrees": 46.86063804569506,
      "Dec": 1.9445019937538122,
      "DecString": "01° 56' 40\"",
      "Epoch": 0,
      "DateTime": {
        "Now": "2024-08-06T12:18:48.5531348+02:00",
        "UtcNow": "2024-08-06T10:18:48.553233Z",
        "MinValue": "0001-01-01T00:00:00",
        "MaxValue": "9999-12-31T23:59:59.9999999"
      }
    },
    "SiteElevation": 110,
    "SecondaryAxisRates": [
      {
        "Item1": 0,
        "Item2": 8
      }
    ],
    "TimeToMeridianFlip": 24,
    "CanPark": true,
    "SiderealTimeString": "07:53:17",
    "CanSetPierSide": false,
    "EquatorialSystem": 0,
    "CanSetRightAscensionRate": true,
    "HasUnknownEpoch": false,
    "AtPark": false,
    "AlignmentMode": 1,
    "SiderealTime": 7.887960053767035,
    "RightAscension": 3.1240425363796707,
    "TimeToMeridianFlipString": "24:00:00",
    "DriverVersion": null,
    "CanSetDeclinationRate": true,
    "CanSlew": true,
    "Altitude": 13.4356807384605,
    "CanSetTrackingEnabled": true,
    "AtHome": false,
    "TrackingEnabled": false,
    "DeclinationString": "01° 56' 40\"",
    "DeviceId": "ScopeSim.Telescope",
    "Name": "Simulator"
  },
  "Error": "",
  "Success": true,
  "Type": "API"
}
property=focuser
{
  "Response": {
    "TempComp": false,
    "Name": "Simulator",
    "DeviceId": "FocusSim.Focuser",
    "SupportedActions": [],
    "DriverInfo": "",
    "DriverVersion": "",
    "IsSettling": false,
    "IsMoving": false,
    "Position": 20000,
    "Temperature": 0.440000000000004,
    "StepSize": 40,
    "Description": "",
    "TempCompAvailable": true,
    "Connected": true,
    "DisplayName": "Simulator"
  },
  "Error": "",
  "Success": true,
  "Type": "API"
}
property=filterwheel
{
  "Response": {
    "Name": "Simulator",
    "DriverVersion": "",
    "SupportedActions": [],
    "DeviceId": "FilterWheelSim.FilterWheel",
    "DriverInfo": "",
    "Connected": true,
    "DisplayName": "Simulator",
    "SelectedFilter": {
      "_name": "Filter 1",
      "_focusOffset": 0,
      "_position": 1,
      "_autoFocusExposureTime": -1,
      "_autoFocusFilter": false,
      "FlatWizardFilterSettings": {
        "FlatWizardMode": 0,
        "HistogramMeanTarget": 0.5,
        "HistogramTolerance": 0.1,
        "MaxFlatExposureTime": 30,
        "MinFlatExposureTime": 0.01,
        "MaxAbsoluteFlatDeviceBrightness": 32767,
        "MinAbsoluteFlatDeviceBrightness": 0,
        "Gain": -1,
        "Offset": -1,
        "Binning": {
          "X": 1,
          "Y": 1
        }
      },
      "_autoFocusBinning": {
        "X": 1,
        "Y": 1
      },
      "_autoFocusGain": -1,
      "_autoFocusOffset": -1
    },
    "Description": "",
    "IsMoving": false
  },
  "Error": "",
  "Success": true,
  "Type": "API"
}
property=guider
{
  "Response": {
    "RMSError": {
      "RA": {
        "Pixel": 0,
        "Arcseconds": 0
      },
      "Dec": {
        "Pixel": 0,
        "Arcseconds": 0
      },
      "Total": {
        "Pixel": 0,
        "Arcseconds": 0
      },
      "PeakRA": {
        "Pixel": 0,
        "Arcseconds": 0
      },
      "PeakDec": {
        "Pixel": 0,
        "Arcseconds": 0
      }
    },
    "PixelScale": 0,
    "Name": "PHD2",
    "DeviceId": "PHD2_Single",
    "SupportedActions": [],
    "DriverInfo": "PHD2 Guider",
    "DriverVersion": "1.0",
    "CanSetShiftRate": true,
    "CanGetLockPosition": true,
    "Description": "PHD2 Guider",
    "CanClearCalibration": true,
    "Connected": true,
    "DisplayName": "PHD2"
  },
  "Error": "",
  "Success": true,
  "Type": "API"
}
property=dome
{
  "Response": {
    "ShutterStatus": 0,
    "AtHome": false,
    "CanSetAzimuth": true,
    "Azimuth": 180,
    "CanPark": true,
    "Name": "Simulator",
    "DeviceId": "DomeSim.Dome",
    "CanSyncAzimuth": true,
    "CanSetPark": true,
    "SupportedActions": [],
    "Slewing": false,
    "DriverVersion": "",
    "AtPark": true,
    "CanFindHome": true,
    "DriverInfo": "ASCOM Dome Simulator 5.0.8\r\nDeveloped by Jon Brewster\r\nhttp://ascom-standards.org/  ",
    "Description": "ASCOM Dome Simulator",
    "DriverFollowing": false,
    "DriverCanFollow": false,
    "CanSetShutter": true,
    "Connected": true,
    "DisplayName": "Simulator"
  },
  "Error": "",
  "Success": true,
  "Type": "API"
}
property=rotator
{
  "Response": {
    "DriverInfo": "ASCOM.Simulator.Rotator",
    "MechanicalPosition": 5,
    "Reverse": false,
    "DeviceId": "ASCOM.Simulator.Rotator",
    "SupportedActions": [],
    "Name": "Rotator Simulator .NET",
    "DriverVersion": "6.6",
    "Synced": false,
    "IsMoving": false,
    "Position": 5,
    "StepSize": 0.75,
    "Description": "ASCOM Rotator Driver for RotatorSimulator",
    "CanReverse": true,
    "Connected": true,
    "DisplayName": "Rotator Simulator .NET"
  },
  "Error": "",
  "Success": true,
  "Type": "API"
}
property=safetymonitor
{
  "Response": {
    "Name": "N.I.N.A. Simulator Safety Device",
    "DriverVersion": "",
    "SupportedActions": [],
    "DeviceId": "613EC0FF-87D7-4475-9352-F6F6EB1CDE75",
    "DriverInfo": "",
    "Connected": true,
    "DisplayName": "N.I.N.A. Simulator Safety Device",
    "Description": "",
    "IsSafe": false
  },
  "Error": "",
  "Success": true,
  "Type": "API"
}
property=flatdevice
{
  "Response": {
    "DriverInfo": "CoverCalibrator driver version: 6.6.2.4195.",
    "Name": "ASCOM CoverCalibrator Simulator",
    "CoverState": 2,
    "DeviceId": "ASCOM.Simulator.CoverCalibrator",
    "MaxBrightness": 100,
    "SupportedActions": [],
    "SupportsOnOff": true,
    "DriverVersion": "6.6",
    "LocalizedLightOnState": "On",
    "LightOn": true,
    "Brightness": 100,
    "Description": "ASCOM CoverCalibrator Simulator",
    "SupportsOpenClose": true,
    "LocalizedCoverState": "Closed",
    "Connected": true,
    "MinBrightness": 0,
    "DisplayName": "ASCOM CoverCalibrator Simulator"
  },
  "Error": "",
  "Success": true,
  "Type": "API"
}
property=switch
{
  "Response": {
    "Name": "ASCOM SwitchV2 Simulator Driver",
    "DriverVersion": "6.6",
    "DisplayName": "ASCOM SwitchV2 Simulator Driver",
    "SupportedActions": [
      "OCHTag",
      "OCHTestPowerReport"
    ],
    "DeviceId": "ASCOM.Simulator.Switch",
    "DriverInfo": "Switch V2 Simulator, version: 6.6.2.4195",
    "Connected": true,
    "WritableSwitches": [],
    "ReadonlySwitches": [
      {
        "Id": 0,
        "Name": "Power1",
        "Description": "Generic power switch",
        "Value": 0
      },
      {
        "Id": 1,
        "Name": "Power2",
        "Description": "Generic Power switch",
        "Value": 0
      },
      {
        "Id": 2,
        "Name": "Light Box",
        "Description": "Light box , 0 to 100%",
        "Value": 0
      },
      {
        "Id": 3,
        "Name": "Flat Panel",
        "Description": "Flat panel , 0 to 255",
        "Value": 0
      },
      {
        "Id": 4,
        "Name": "Scope Cover",
        "Description": "Scope cover control true is closed, false is open",
        "Value": 0
      },
      {
        "Id": 5,
        "Name": "Scope Parked",
        "Description": "Scope parked switch, true if parked",
        "Value": 0
      },
      {
        "Id": 6,
        "Name": "Cloudy",
        "Description": "Cloud monitor: 0=clear, 1=light cloud, 2= heavy cloud",
        "Value": 0
      },
      {
        "Id": 7,
        "Name": "Temperature",
        "Description": "Temperature in deg C",
        "Value": 12
      },
      {
        "Id": 8,
        "Name": "Humidity",
        "Description": "Relative humidity %",
        "Value": 50
      },
      {
        "Id": 9,
        "Name": "Raining",
        "Description": "Rain monitor, true if raining",
        "Value": 0
      }
    ],
    "Description": "ASCOM SwitchV2 Simulator Driver."
  },
  "Error": "",
  "Success": true,
  "Type": "API"
}
property=image
{
  "Response": "<Base64-Encoded Image>",
  "Error": "",
  "Success": true,
  "Type": "API"
}
property=weather
{
  "Response": {
    "Humidity": 52,
    "DriverVersion": "1.0",
    "DriverInfo": "NINA internal OpenWeatherMap API client",
    "SupportedActions": [],
    "StarFWHM": "NaN",
    "SkyQuality": "NaN",
    "WindGust": "NaN",
    "SkyBrightness": "NaN",
    "SkyTemperature": "NaN",
    "WindSpeed": 1.5,
    "AveragePeriod": 0,
    "CloudCover": 30,
    "RainRate": "NaN",
    "Temperature": 25.560000000000002,
    "Name": "OpenWeatherMap",
    "Description": "Uses OpenWeatherMap's Current Weather API. Weather data is refreshed every 10 minutes.",
    "DeviceId": "NINA.OpenWeatherMap.Client",
    "DewPoint": 15.158650029965683,
    "WindDirection": 136,
    "Connected": true,
    "DisplayName": "OpenWeatherMap",
    "Pressure": 1012
  },
  "Error": "",
  "Success": true,
  "Type": "API"
}