ANangelcam
camera

Retrieve camera

get/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 frames per second sent in an MJPEG stream. For example, if you want to get an MJPEG stream with frame sent every 10 seconds, use value 0.1.

max_widthinteger

Maximum frame width for the MJPEG stream and LIVE SNAPSHOT.

max_heightinteger

Maximum frame height for the MJPEG stream and LIVE SNAPSHOT.

stream_expires_atstring date-time

Date and time when the returned camera streams should stop. By default, the returned streams have no expiration allowing the consumer to pull them indefinitely.

Do not confuse this with expiration of the stream URLs themselves. The stream URLs have a short expiration in order to minimize the risk of leaking and this behavior cannot be changed. However, once a stream URL is used to establish a connection, the returned stream can be pulled indefinitely unless the stream_expires_at parameter is used.

Response

Camera object

idinteger required

Camera ID

namestring required

Camera name

locationinteger nullable required

ID of the location the camera belongs to

siteinteger nullable required

ID of the location the camera belongs to. Deprecated: use location instead.

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

Camera type

status'offline' | 'online' | 'unknown' required
event_api_hashstring

Event API hash - unique token for posting events to camera timeline from embedded devices without authentication (do not disclose)

live_snapshotstring uri nullable required

Live snapshot URL

low_latency_enabledboolean required

Indicates if user enabled low latency streaming in camera settings.

audio_enabledboolean required

Indicates if audio is enabled for given camera.

enable_status_checksboolean required

Indicates if periodic online/offline checks for the camera are enabled.

enable_periodical_snapshotsboolean required

Indicates if camera snapshot is being refreshed automatically once every 24h.

tagsstring[] required

List of tags assigned to the camera. Tags can be used for filtering.

Example response

{
  "id": 157,
  "name": "Parkside Office",
  "location": 1,
  "site": 1,
  "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": "mpegts",
      "url": "http://m1.angelcam.com/stream/81/stream.ts?token=eyJ0aW1lIjogMTQ5NjkzNDYyODE5NjMxNiwgInRpbWVvdXQiOiAzNjAwLCAiYWxpYXMiOiAiODEifQ==.b5b4cf405cf054701a75b359f4069d2af8a102c5ffd8f33cbb560a4638c7cb71"
    },
    {
      "format": "hls",
      "url": "http://m1.angelcam.com/stream/81/playlist.m3u8?token=eyJ0aW1lIjogMTQ5NjkzNDYyODE5NjQwMSwgInRpbWVvdXQiOiAzNjAwLCAiYWxpYXMiOiAiODEifQ==.8ac35b434e768e8f10161b2d74da492f5fd8a8c115c18cbb421017665acd908a"
    }
  ],
  "applications": [
    "LSA",
    "CRA"
  ],
  "low_latency_enabled": false,
  "audio_enabled": true,
  "enable_status_checks": true,
  "enable_periodical_snapshots": true,
  "tags": [
    "office",
    "entrance"
  ]
}

Changes

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