Skip to main content
GET
/
api
/
cameras
/
{cameraId}
/
properties
/
{propertyName}
Get a camera property
curl --request GET \
  --url http://{host}:{port}/api/cameras/{cameraId}/properties/{propertyName}
{
  "success": true,
  "data": {
    "property": "<string>",
    "value": "0x1007d",
    "formatted": "1/125",
    "writable": true,
    "available_values": [
      {
        "value": "0x11f40",
        "formatted": "1/8000"
      }
    ]
  },
  "message": "<string>",
  "camera": {
    "connected": false,
    "model": "ILCE-7M4",
    "id": "D06CE05E3323"
  }
}

Documentation Index

Fetch the complete documentation index at: https://crsdk.app/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
cameraId
string
required

Camera identifier (e.g. D10F60149B0C)

​
propertyName
enum<string>
required

Property name Canonical REST property names. Mirrors the server's PROPERTY_MAP (webapp/server/src/CameraWebController.cpp). Use GET /properties/all to see the full set with current values, writability, and accepted ranges for the connected camera.

Some properties are read-only on every body (status / state fields). Others are read-only depending on shooting mode (e.g. aperture is read-only outside Manual / Aperture-priority modes). Always check the writable field on a single GET before attempting a SET.

Property tiers

Core (R/W): iso, aperture, shutter-speed, drive-mode, white-balance, focus-mode, exposure-program-mode, still-image-store-destination

Image format: file-format, image-quality, raw-compression

Focus: focus-area, focus-distance (read), focus-position, focus-position-current (read), focus-driving-status (read)

Zoom: zoom-distance (read), zoom-setting

Battery / power: battery-remain (read)

Video state / format: recording-state (read), movie-file-format, movie-recording-setting, movie-recording-frame-rate

Thermal / errors: overheating-state (read), camera-error-caution-status (read), system-error-caution-status (read), camera-system-error-info (read)

Media slots: media-slot1-status, media-slot1-remaining-photos, media-slot1-remaining-time, media-slot2-status, media-slot2-remaining-photos, media-slot2-remaining-time (all read)

Exposure: exposure-compensation, metering-mode, ae-lock, exposure-step

Flash: flash-mode, flash-compensation, wireless-flash

Shutter / silent: shutter-type, shutter-mode, silent-mode, shutter-angle

Image: image-size, aspect-ratio, color-space, dro, high-iso-nr

WB fine-tune: awb-lock, white-balance-color-temp

Creative / picture profile: creative-look, flicker-less-shooting, picture-profile, pp-lut-base-look

Audio: audio-recording, audio-input-master-level

Timecode: timecode-preset, timecode-format, timecode-run, timecode-make

Stabilization / NR: image-stabilization, movie-stabilization, long-exposure-nr

CineEI / LUT: movie-shooting-mode, movie-shooting-mode-color-gamut, base-look-import-enable, embed-lut-file, base-look-value, shooting-enable, exposure-index, base-iso, aps-c-s35

Image ID (MakerNote): image-id-string, image-id-string-max-length, image-id-num, image-id-num-setting

Priority: priority-key (also exposed as /priority-key resource)

Available options:
priority-key,
iso,
aperture,
shutter-speed,
drive-mode,
white-balance,
focus-mode,
exposure-program-mode,
still-image-store-destination,
file-format,
image-quality,
raw-compression,
focus-area,
focus-distance,
focus-position,
focus-position-current,
focus-driving-status,
zoom-distance,
zoom-setting,
battery-remain,
recording-state,
movie-file-format,
movie-recording-setting,
movie-recording-frame-rate,
overheating-state,
camera-error-caution-status,
system-error-caution-status,
camera-system-error-info,
media-slot1-status,
media-slot1-remaining-photos,
media-slot1-remaining-time,
media-slot2-status,
media-slot2-remaining-photos,
media-slot2-remaining-time,
exposure-compensation,
metering-mode,
ae-lock,
exposure-step,
flash-mode,
flash-compensation,
wireless-flash,
shutter-type,
shutter-mode,
silent-mode,
shutter-angle,
image-size,
aspect-ratio,
color-space,
dro,
high-iso-nr,
awb-lock,
white-balance-color-temp,
creative-look,
flicker-less-shooting,
picture-profile,
pp-lut-base-look,
audio-recording,
audio-input-master-level,
timecode-preset,
timecode-format,
timecode-run,
timecode-make,
image-stabilization,
movie-stabilization,
long-exposure-nr,
movie-shooting-mode,
movie-shooting-mode-color-gamut,
base-look-import-enable,
embed-lut-file,
base-look-value,
shooting-enable,
exposure-index,
base-iso,
aps-c-s35,
image-id-string,
image-id-string-max-length,
image-id-num,
image-id-num-setting

Response

Property retrieved

​
success
boolean
required
​
data
object
required

Single-property GET payload returned under data by GET /api/cameras/{id}/properties/{name}.

​
message
string
​
camera
object

Camera info embedded in API responses