ANangelcam
shared-camera

Retrieve shared camera

get/shared-cameras/{camera_id}/

Request

  • Base URL
    https://api.angelcam.com/v1
  • Auth
    • OAuth 2
      Authorization codehttps://my.angelcam.com/oauth/authorize/, token URL https://my.angelcam.com/oauth/token/
      PasswordToken URL https://api.angelcam.com/oauth/token/
      Scopescamera_access
    • or API key in header Authorization
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

camera_idinteger required

Camera ID

Query parameters

refresh_ratenumber float

Set a maximum number of keyframes sent in MJPEG stream per second. For example if you want to have MJPEG stream with keyframe sent every 10 seconds, post value 0.1.

max_widthinteger

Maximum width of MJPEG stream and LIVE SNAPSHOT.

max_heightinteger

Maximum height of MJPEG stream and LIVE SNAPSHOT.

Response

Camera object

idinteger required

Camera ID

namestring required

Camera name

type'h264' | 'h265' | 'mjpeg' required

Camera type

status'offline' | 'online' | 'unknown' required
live_snapshotstring uri nullable required

Live snapshot URL

has_recordingboolean required

Indicates whether the user to whom the camera is shared can access camera recordings

has_notificationsboolean required

Indicates whether the user to whom the camera is shared will receive notifications (eg. security alerts) related to the camera

Example response

{
  "id": 157,
  "name": "Parkside Office",
  "type": "h264",
  "snapshot": {
    "url": "https://dsw4ncxjbie85.cloudfront.net/snapshot/81/y8jol6kbn0ol1gh2.jpg",
    "created_at": "2017-03-29T15:41:39.000Z"
  },
  "status": "online",
  "live_snapshot": "http://m1.angelcam.com/stream/81/snapshot.jpg?token=eyJ0aW1lIjogMTQ5NjkzNDYyODE5NjIxOCwgInRpbWVvdXQiOiAzNjAwLCAiYWxpYXMiOiAiODEifQ==.85b552be2b7f0abaa0a3b5b4f412877f8af92f691c7d0c6db6b8c517ea8f921c",
  "streams": [
    {
      "format": "mjpeg",
      "url": "http://m1.angelcam.com/stream/81/stream.mjpeg?token=eyJ0aW1lIjogMTQ5NjkzNDYyODE5NjIxOCwgInRpbWVvdXQiOiAzNjAwLCAiYWxpYXMiOiAiODEifQ==.85b552be2b7f0abaa0a3b5b4f412877f8af92f691c7d0c6db6b8c517ea8f921c",
      "refresh_rate": 0.1
    },
    {
      "format": "mp4",
      "url": "http://m1.angelcam.com/stream/81/stream.mp4?token=eyJ0aW1lIjogMTQ5NjkzNDYyODE5NjMxNiwgInRpbWVvdXQiOiAzNjAwLCAiYWxpYXMiOiAiODEifQ==.b5b4cf405cf054701a75b359f4069d2af8a102c5ffd8f33cbb560a4638c7cb71"
    },
    {
      "format": "hls",
      "url": "http://m1.angelcam.com/stream/81/playlist.m3u8?token=eyJ0aW1lIjogMTQ5NjkzNDYyODE5NjQwMSwgInRpbWVvdXQiOiAzNjAwLCAiYWxpYXMiOiAiODEifQ==.8ac35b434e768e8f10161b2d74da492f5fd8a8c115c18cbb421017665acd908a"
    }
  ],
  "applications": [
    "CRA"
  ],
  "owner": {
    "email": "john@apple.com",
    "first_name": "John",
    "last_name": "Appleseed"
  },
  "has_recording": false,
  "has_notifications": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.