Advanced API

Advanced API
2.2.13

View as Markdown
Base URL 
http://localhost:1888/v2/api

This is the API documentation for the NINA plugin Advanced API. Please use streaming instead of the default base64 encoding for images, as base64 support will be removed in the near future!

This is version 2.2.13 of this API documentation. Last update on Dec 4, 2025.
GET /application/plugins

Get a list of installed plugins. This is useful for example if you want to use an integrated plugin like livestack or TPPA

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • Response array(string)
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 500 application/json

    Internal server error, Unknown error

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
GET /application/plugins 
curl \
 --request GET 'http://localhost:1888/v2/api/application/plugins'
Response examples (200) 
{
  "Response": [
    "Advanced API",
    "Livestack",
    "Three Point Polar Alignment",
    "Touch 'N' Stars"
  ],
  "Error": "string",
  "StatusCode": 200,
  "Success": true,
  "Type": "API"
}
Response examples (500) 
{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}

Capture Statistics

View as Markdown
GET /equipment/camera/capture/statistics

This endpoint returns the image statistics for the last captured image.

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • Response object
      Hide Response attributes Show Response attributes object
      • Stars integer
      • HFR number
      • Median number
      • MedianAbsoluteDeviation number
      • Mean number
      • Max integer
      • Min integer
      • StDev number
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 400 application/json

    Capture not available

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 500 application/json

    Internal server error, Unknown error

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
GET /equipment/camera/capture/statistics 
curl \
 --request GET 'http://localhost:1888/v2/api/equipment/camera/capture/statistics'
Response examples (200) 
{
  "Response": {
    "Stars": 42,
    "HFR": 42.0,
    "Median": 42.0,
    "MedianAbsoluteDeviation": 42.0,
    "Mean": 42.0,
    "Max": 42,
    "Min": 42,
    "StDev": 42.0
  },
  "Error": "string",
  "StatusCode": 42,
  "Success": true,
  "Type": "string"
}
Response examples (400) 
{
  "Response": "No image available",
  "Error": "string",
  "StatusCode": 409,
  "Success": false,
  "Type": "API"
}
Response examples (500) 
{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}
GET /equipment/dome/list-devices

List all devices which can be connected

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • Response array[object]
      Hide Response attributes Show Response attributes object
      • HasSetupDialog boolean
      • Id string
      • Name string
      • DisplayName string
      • Category string
      • Connected boolean
      • Description string
      • DriverInfo string
      • DriverVersion string
      • SupportedActions array
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 500 application/json

    Internal server error, Unknown error

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
GET /equipment/dome/list-devices 
curl \
 --request GET 'http://localhost:1888/v2/api/equipment/dome/list-devices'
Response examples (200) 
{
  "Response": [
    {
      "HasSetupDialog": true,
      "Id": "string",
      "Name": "string",
      "DisplayName": "string",
      "Category": "string",
      "Connected": true,
      "Description": "string",
      "DriverInfo": "string",
      "DriverVersion": "string",
      "SupportedActions": []
    }
  ],
  "Error": "string",
  "StatusCode": 200,
  "Success": true,
  "Type": "API"
}
Response examples (500) 
{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}

Stop Dome Movement

View as Markdown
GET /equipment/dome/stop

Stop Dome movement.

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 409 application/json

    Dome not connected

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 500 application/json

    Internal server error, Unknown error

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
GET /equipment/dome/stop 
curl \
 --request GET 'http://localhost:1888/v2/api/equipment/dome/stop'
Response examples (200) 
{
  "Response": "Movement stopped",
  "Error": "string",
  "StatusCode": 200,
  "Success": true,
  "Type": "API"
}
Response examples (409) 
{
  "Response": "string",
  "Error": "Dome not connected",
  "StatusCode": 409,
  "Success": false,
  "Type": "API"
}
Response examples (500) 
{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}

Sync Dome To Telescope

View as Markdown
GET /equipment/dome/sync

Sync dome to telescope coordinates

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 409 application/json

    Dome not connected

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 500 application/json

    Internal server error, Unknown error

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
GET /equipment/dome/sync 
curl \
 --request GET 'http://localhost:1888/v2/api/equipment/dome/sync'
Response examples (200) 
{
  "Response": "Dome Sync Started",
  "Error": "string",
  "StatusCode": 200,
  "Success": true,
  "Type": "API"
}
Response examples (409) 
{
  "Response": "string",
  "Error": "Dome not connected",
  "StatusCode": 409,
  "Success": false,
  "Type": "API"
}
Response examples (500) 
{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}

Flat Panel

Set Brightness

View as Markdown
GET /equipment/flatdevice/set-brightness

Set Brightness

Query parameters

  • brightness integer(int32) Required

    Brightness

    Minimum value is 0, maximum value is 100.

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 409 application/json

    Flatdevice not connected

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 500 application/json

    Internal server error, Unknown error

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
GET /equipment/flatdevice/set-brightness 
curl \
 --request GET 'http://localhost:1888/v2/api/equipment/flatdevice/set-brightness?brightness=42'
Response examples (200) 
{
  "Response": "Flatdevice brightness set",
  "Error": "string",
  "StatusCode": 200,
  "Success": true,
  "Type": "API"
}
Response examples (409) 
{
  "Response": "string",
  "Error": "Flatdevice not connected",
  "StatusCode": 409,
  "Success": false,
  "Type": "API"
}
Response examples (500) 
{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}
GET /equipment/focuser/connect

Connect to Focuser

Query parameters

  • to string

    The Id of the device that should be connected.

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 500 application/json

    Internal server error, Unknown error

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
GET /equipment/focuser/connect 
curl \
 --request GET 'http://localhost:1888/v2/api/equipment/focuser/connect'
Response examples (200) 
{
  "Response": "Connected",
  "Error": "string",
  "StatusCode": 200,
  "Success": true,
  "Type": "API"
}
Response examples (500) 
{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}
GET /equipment/mount/list-devices

List all devices which can be connected

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • Response array[object]
      Hide Response attributes Show Response attributes object
      • HasSetupDialog boolean
      • Id string
      • Name string
      • DisplayName string
      • Category string
      • Connected boolean
      • Description string
      • DriverInfo string
      • DriverVersion string
      • SupportedActions array
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 500 application/json

    Internal server error, Unknown error

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
GET /equipment/mount/list-devices 
curl \
 --request GET 'http://localhost:1888/v2/api/equipment/mount/list-devices'
Response examples (200) 
{
  "Response": [
    {
      "HasSetupDialog": true,
      "Id": "string",
      "Name": "string",
      "DisplayName": "string",
      "Category": "string",
      "Connected": true,
      "Description": "string",
      "DriverInfo": "string",
      "DriverVersion": "string",
      "SupportedActions": []
    }
  ],
  "Error": "string",
  "StatusCode": 200,
  "Success": true,
  "Type": "API"
}
Response examples (500) 
{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}

Change Profile Value

View as Markdown
GET /profile/change-value

Changes a value in the profile

Query parameters

  • settingpath string Required

    The path to the setting to change. (eg. CameraSettings-PixelSize). This refers the the profile structure like it is recieved when using /profile/show?active=true. Seperate each object with a dash (-)

  • newValue object Required

    The new value to set

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
  • 400 application/json

    Invalid path / Invalid value

    Hide response attributes Show response attributes object
    • Response string
    • Error string

      Values are Invalid path or New value can't be null.

    • StatusCode integer
    • Success boolean
    • Type string
  • 500 application/json

    Internal server error, Unknown error

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
GET /profile/change-value 
curl \
 --request GET 'http://localhost:1888/v2/api/profile/change-value?settingpath=CameraSettings-PixelSize&newValue=3.2'
Response examples (200) 
{
  "Response": "Updated setting",
  "Error": "string",
  "StatusCode": 200,
  "Success": true,
  "Type": "API"
}
Response examples (400) 
{
  "Response": "string",
  "Error": "Invalid path",
  "StatusCode": 400,
  "Success": false,
  "Type": "API"
}
Response examples (500) 
{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}
GET /equipment/rotator/info

Get rotator information

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • Response object Required
      Hide Response attributes Show Response attributes object
      • CanReverse boolean Required
      • Reverse boolean Required
      • MechanicalPosition integer Required
      • Position integer Required
      • StepSize number Required
      • IsMoving boolean Required
      • Synced boolean Required
      • SupportedActions array Required
      • Connected boolean Required
      • Name string Required
      • DisplayName string Required
      • Description string Required
      • DriverInfo string Required
      • DriverVersion string Required
      • DeviceId string Required
    • Error string Required
    • StatusCode integer Required
    • Success boolean Required
    • Type string Required
  • 500 application/json

    Internal server error, Unknown error

    Hide response attributes Show response attributes object
    • Response string
    • Error string
    • StatusCode integer
    • Success boolean
    • Type string
GET /equipment/rotator/info 
curl \
 --request GET 'http://localhost:1888/v2/api/equipment/rotator/info'
Response examples (200) 
{
  "Response": {
    "CanReverse": true,
    "Reverse": true,
    "MechanicalPosition": 42,
    "Position": 42,
    "StepSize": 42.0,
    "IsMoving": true,
    "Synced": true,
    "SupportedActions": [],
    "Connected": true,
    "Name": "string",
    "DisplayName": "string",
    "Description": "string",
    "DriverInfo": "string",
    "DriverVersion": "string",
    "DeviceId": "string"
  },
  "Error": "string",
  "StatusCode": 42,
  "Success": true,
  "Type": "string"
}
Response examples (500) 
{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}