Get Stacked Image | Advanced API documentation

Get Stacked Image

GET /livestack/{target}/{filter}

Gets the stacked image from the livestack plugin for a given target and filter.

Path parameters

target string Required
filter string Required

Responses

200

application/json

application/json image/png image/jpg

Successful response
Hide response attributes Show response attributes object
- Response string
- Error string
- StatusCode integer
- Success boolean
- Type string
Image in png format, when stream is set to true and the image quality is not specified or set to -1

Image in jpg format, when stream is set to true and the image quality is specified
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 /livestack/{target}/{filter}

curl \
 --request GET 'http://localhost:1888/v2/api/livestack/M31/RGB'

Response examples (200)

{
  "Response": "<base64 encoded image>",
  "Error": "string",
  "StatusCode": 200,
  "Success": true,
  "Type": "API"
}

Response examples (500)

{
  "Response": "string",
  "Error": "Unknown error",
  "StatusCode": 500,
  "Success": false,
  "Type": "API"
}