Live API

GET /live/list

List of live events

Example request:

GET /live/list?max_results=2&api_key=key-XXXXXXXXXXXXX HTTP/1.1
Host: api.dvidshub.net
Accept-encoding: gzip, deflate
User-Agent: Zend_Http_Client
Accept: application/json, text/javascript
Referer: https://api.dvidshub.net

Example response:

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
Transfer-encoding: chunked
Connection: keep-alive
Date: Thu, 22 May 2025 00:37:23 GMT
Server: Apache
Access-control-allow-origin: *
Content-encoding: gzip
Vary: Accept-Encoding
X-cache: Miss from cloudfront
Via: 1.1 eb8674b99d3dfcc6867fb20af353442a.cloudfront.net (CloudFront)
X-amz-cf-pop: IAD12-P4
Alt-svc: h3=":443"; ma=86400
X-amz-cf-id: _3EQJbQjM14BATvJ2PbPsSI54fvpxTzW-L4W1R8ij7cgHz7v-1AhcA==

{
    "results":[
        {
            "type":"live_webcasts",
            "id":"36081",
            "title":"Navy Recruit Training Command Graduation",
            "description":"Navy boot camp graduation from Recruit Training Command, Great Lakes, IL. Feed begins at 9:45 a.m. EDT.",
            "hashtag":"",
            "begin":"2025-05-22T13:35:00+00:00",
            "end":"2025-05-22T16:00:00+00:00",
            "thumbnail":{
                "url":"https:\/\/d1ldvf68ux039x.cloudfront.net\/thumbs\/webcast\/dod_default\/122x92_q95.jpg",
                "width":122,
                "height":92
            },
            "url":"https:\/\/www.dvidshub.net\/webcast\/36081",
            "hls_url":"https:\/\/d1b55jk78a7el0.cloudfront.net\/out\/v1\/1d4a1a50b52b4333894d00ce0c4c7ca5\/index.m3u8",
            "unit_id":"127"
        },
        {
            "type":"live_webcasts",
            "id":"36109",
            "title":"Brig Gen Cornell's Retirement Ceremony ",
            "description":"Brig Gen Cornell's Retirement Ceremony.",
            "hashtag":"",
            "begin":"2025-05-22T13:45:00+00:00",
            "end":"2025-05-22T16:10:00+00:00",
            "thumbnail":{
                "url":"https:\/\/d1ldvf68ux039x.cloudfront.net\/thumbs\/webcast\/dod_default\/122x92_q95.jpg",
                "width":122,
                "height":92
            },
            "url":"https:\/\/www.dvidshub.net\/webcast\/36109",
            "hls_url":"https:\/\/d7e306zdqcax0.cloudfront.net\/out\/v1\/f1fbcdcc778649108826fff48382c641\/index.m3u8",
            "unit_id":"7810"
        }
    ],
    "current_time":"2025-05-22T00:37:23+00:00"
}

Query Parameters:

  • api_key: Public API access key issued by DVIDS (key-xxxxxxxxxxxxx)
  • from_date: Specify a date/time in ISO8601 format to return events newer than from_date
  • has_video_id: [1] If set only return events that have a video_id associated with it
  • hashtag: If set only return events with that hashtag specified
  • max_results: [1-50] Maximum number of results to return per page. Default and maximum value are both 50.
  • prettyprint: [1] Spaces out JSON response in more readable format useful for debugging
  • sort: One of begin, end
  • sortdir: One of asc, desc
  • thumb_width: [1-2000] Width of thumbnail in pixels. If thumb_height is provided, this defaults to the aspect ratio native width of the asset relative to the height requested. Otherwise the resolution is 122x92. Max of 2000.
  • thumb_height: [1-2000] Height of thumbnail in pixels. If thumb_width is provided, this defaults to the aspect ratio native height of the asset relative to the width requested. Otherwise the resolution is 122x92. Max of 2000.
  • thumb_quality: [1-100] Quality of generated thumbnail. Default is 95
  • to_date: Specify a date/time in ISO8601 format to return events older than to_date

Status Codes:

  • 200: no error
  • 400: invalid parameter(s) specified. See errors element in response for details.
  • 403: api_key not provided, invalid, or accessed from origin (protocol+domain) other than the one associated with the key provided.

Response Fields:

  • id: Id of the live event
  • type: Type of live event (live_webcast)
  • begin: Date/time event starts in ISO8601 format
  • current_time: Current server date/time in ISO8601 format. Useful for calculating time offset between server and client to provide time sync
  • description: Event description
  • end: Date/time event ends in ISO8601 format
  • thumbnail: [array] Resized image of event poster as specified by thumb_XXX params
  • url: Url to asset on dvidshub.net
  • video_id: Returned if the live event has been linked to a video asset

GET /live/get

Get additional details about live event including links to feed(s)

Example request:

GET /live/get?id=3852&api_key=key-XXXXXXXXXXXXX HTTP/1.1
Host: api.dvidshub.net
Accept-encoding: gzip, deflate
User-Agent: Zend_Http_Client
Accept: application/json, text/javascript
Referer: https://api.dvidshub.net

Example response:

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
Content-length: 594
Connection: keep-alive
Date: Thu, 22 May 2025 00:37:24 GMT
Access-control-allow-origin: *
Server: Apache
X-cache: Miss from cloudfront
Via: 1.1 0d5152d594f96742d61c8aadd196aec6.cloudfront.net (CloudFront)
X-amz-cf-pop: IAD12-P4
Alt-svc: h3=":443"; ma=86400
X-amz-cf-id: -_IEPLiQH_7TfbdI8TAoUwMvvY-9aU0j67Nu_yCVLbfy_ntPilpe9Q==

{
    "current_time":"2025-05-22T00:37:24+00:00",
    "results":{
        "id":"3852",
        "title":"US Department of State Press Briefing",
        "description":"Marie Harf, US Department of State Deputy Spokesperson, will deliver the daily press briefing. Feed begins at 1:30 PM EDT.  *** Time subject to change.",
        "begin":"2014-04-03T17:25:00+00:00",
        "end":"2014-04-03T19:48:00+00:00",
        "hls_url":null,
        "thumbnail":{
            "url":"https:\/\/d1ldvf68ux039x.cloudfront.net\/thumbs\/frames\/video\/1404\/326950\/122x92_q95.jpg",
            "width":122,
            "height":92
        },
        "url":"https:\/\/www.dvidshub.net\/webcast\/3852",
        "video_id":"326950",
        "unit_id":"127"
    }
}

Query Parameters:

  • api_key: Public API access key issued by DVIDS (key-xxxxxxxxxxxxx)
  • fields: Comma separated list of which fields to return
  • id: [int] Id of of the live event
  • prettyprint: [1] Spaces out JSON response in more readable format useful for debugging
  • thumb_width: [1-2000] Width of thumbnail in pixels. If thumb_height is provided, this defaults to the aspect ratio native width of the asset relative to the height requested. Otherwise the resolution is 122x92. Max of 2000.
  • thumb_height: [1-2000] Height of thumbnail in pixels. If thumb_width is provided, this defaults to the aspect ratio native height of the asset relative to the width requested. Otherwise the resolution is 122x92. Max of 2000.
  • thumb_quality: [1-100] Quality of generated thumbnail. Default is 95
  • video_id: Returned if the current event has been linked to a video asset

Status Codes:

  • 200: no error
  • 400: invalid parameter(s) specified. See errors element in response for details.
  • 403: api_key not provided, invalid, or accessed from origin (protocol+domain) other than the one associated with the key provided.

Response Fields:

  • id: Id of the live event
  • begin: Date/time event starts in ISO8601 format
  • current_time: Current server date/time in ISO8601 format. Useful for calculating time offset between server and client to provide time sync
  • description: Event description
  • end: Date/time event ends in ISO8601 format
  • hls_url: Url to master m3u8 playlist for event
  • thumbnail: [array] Resized image of event poster as specified by thumb_XXX params
  • url: Url to asset on dvidshub.net
  • video_id: Returned if the live event has been linked to a video asset