Advanced API

Get Stacked Image

GET /livestack/image/{target}/{filter}

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

Path parameters

  • target string Required
  • filter string Required

Query parameters

  • resize boolean

    Whether to resize the image.

  • quality integer(int32)

    The quality of the image, ranging from 1 (worst) to 100 (best). -1 or omitted for png

  • size string

    The size of the image ([width]x[height]). Requires resize to be true.

  • scale number(double)

    The scale of the image. Requires resize to be true.

  • stream boolean

    Stream the image to the client. This will stream the image in image/jpg or image/png format.

Responses

  • 200

    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/image/{target}/{filter} 
curl \
 --request GET 'http://localhost:1888/v2/api/livestack/image/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"
}