---
title: "Fetch a real-time stream"
method: GET
path: "/real_time/{id}"
tags: ["real_time"]
---

# Fetch a real-time stream

`GET /real_time/{id}`

This operation shows the details of a specific real-time stream.

## Path parameters

- `id` string, required

## Response `200`

Success

- object
  - `real_time_stream` RealTimeStream, required
    - `created_at` string, date-time — The date and time that the real-time stream was created.
    - `id` string — The unique identifier of the real-time stream. Use this ID to perform other operations on the stream, like getting the details of the stream or deleting it.
    - `name` string — A descriptive name for the real-time stream.
    - `stream_name` string — The generated alphanumeric stream name you pass to the SDK.
    - `token` string — The authentication token you pass to the SDK.
    - `subscribe_token` string — A secure token that must be passed by viewers for playback. Generated after you set *enable_secure_viewer* to **true**.
    - `rtmp_url` string — The URL you can use to configure an RTMP encoder as the source.
    - `enable_secure_viewer` boolean — Require viewers to pass a security token for playback.
    - `expires_on` string, date-time — The date and time the security token expires. Specify **YYYY-MM-DD HH:MM:SS**, where **HH** is a 24-hour clock in UTC. If you don't specify **HH:MM:SS**, the token expires at 12AM UTC on the specified day. Required when *enable_secure_viewer* is **true**.
    - `state` 'started' | 'stopped' | 'disabled' — The state of the stream.
    - `region` 'phoenix' | 'amsterdam' | 'singapore' | 'bangalore' | 'auto' — An option to set the regional server the stream is distributed through. Select the region closest to your broadcast location for the most reliable stream. If you select the auto option, Wowza Video selects the region based on the publisher's location. **Default:** phoenix **Example:** <code>"region": amsterdam</code>
    - `recording` boolean — If **true**, records the real-time stream so you can download an MP4 later. The recording starts when the stream starts and stops automatically when the stream stops. Recordings for real-time streams capture up to twelve hours of content in a single MP4 file. If the real-time stream recording is longer twelve hours, you'll have multiple files for the recording. **Default:** false <blockquote>Note: You can't update this value after you create the stream.</blockquote> **Example:** <code>"recording": true</code>
    - `reference_id` string — A unique, alphanumeric ID returned in real-time stream webhook payloads. Setting a *reference_id* is useful if you have an ID in your system or application you want to associate with real-time stream events that trigger webhooks. Maximum 70 characters. Can only contain: a-z A-Z 0-9 !@#$%^&*()-_+=:;,.?~| You can't use brackets or quotation marks. See <a href="https://www.wowza.com/docs/wowza-video-webhook-event-reference-documentation">Wowza Video Webhook Event Reference Documentation</a> to learn about webhooks. Available from version 1.12. **Example:** <code>"reference_id": "mySystemID_01"</code>
    - `disable_vod_encoder` boolean — Skips VOD encoding and only creates an MP4 file for download. No VOD stream is created from the real-time stream. Can only be set when **recording** is true and you can't change this value after you create the stream. **Default:** false **Example:** <code>"disable_vod_encoder": true</code>
    - `description` string — An optional description of the real-time stream.
    - `enable_player_and_hosted_page` boolean — If **true**, enables a player and hosted page for the real-time stream. **Default:** true <blockquote>Note: You can't update this value after you create the stream.</blockquote> **Example:** <code>"enable_player_and_hosted_page": true</code>
    - `player_id` string — (Available from version 2.0) The unique alphanumeric string that identifies the player configuration to use for this stream. When you pass a player configuration ID, Wowza Video uses that player configuration to customize and style the player. If you don't pass a value, the default player configuration for the account is used. Create and edit player configurations in the user interface. The ID is on the **General** tab for the player configuration. **Default**: Default player configuration <blockquote><strong>Note</strong>: <strong>player_id</strong> is not returned in the response if it's not explicitly sent and the default player configuration is used instead.</blockquote> **Example**: 2205b4e8-b160-43c2-868d-d88698a4e850
    - `player_type` 'wowza_flowplayer_v1' | 'wowza_flowplayer_v2' — (Available from version 2.0) The type of player associated with the stream. Streams created in legacy Wowza Video have a player type of *wowza_flowplayer_v1*. Streams created in later versions of Wowza Video have a player type of *wowza_flowplayer_v2*. Knowing the player type is useful if you've migrated streams from legacy Wowza Video. The player for a stream created in the legacy version of Wowza Video isn't editable in the new platform. **Example**: wowza_flowplayer_v1
    - `flowplayer` boolean — Indicates whether or not the player for the live stream is a Wowza Flowplayer player. **True** indicates the player is a Wowza Flowplayer player. Our new Wowza Video experience uses Wowza Flowplayer. If you are a Wowza Video legacy subscriber, Wowza Flowplayer is also the player used. **False** indicates the player is either an **original_html5** player or **wowza_player**. The original HTML and Wowza players are the players available for Wowza Streaming Cloud subscribers.
    - `embed_code` string — The HTML code that can be used in an external webpage to host the Wowza Flowplayer.
    - `logo_image_url` string — The path to a GIF, JPEG, or PNG logo file that appears partially transparent in a corner of the player throughout playback. Logo file must be 2.5 MB or smaller.
    - `logo_position` 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' — The corner of the player in which you want the player logo to appear. The default is **top-left**. **Example:** <code>"logo_position": "top-right"</code>
    - `video_poster_image_url` string — The path to a GIF, JPEG, or PNG poster image that appears in the player before the stream begins. Poster image files must be 2.5 MB or smaller.
    - `width` integer — The width, in pixels, of a fixed-size player. The default is **640**. **Example:** <code>"width": 640</code>
    - `hosted_page` object — Configuration of the hosted page.
      - `url` string — The URL of the Wowza Video-hosted webpage that viewers can visit to watch the stream.
      - `title` string — A title for the page that appears above the player. Can't include custom HTML, JavaScript, or other tags. **Example:** <code>"title": "My Hosted Page"</code>
      - `description` string — A description that appears on the hosted page below the player. Can't include custom HTML, JavaScript, or other tags. **Example:** <code>"description": "My Hosted Page Description"</code>
      - `logo_image_url` string — The path to a GIF, JPEG, or PNG logo file that appears in the upper-left corner of the hosted page. Logo file must be 2.5 MB or smaller.
      - `sharing_icons` boolean — Icons that let viewers share the stream on Facebook, Google+, Twitter, and by email. The default, **true**, includes sharing icons on the hosted page. Specify **false** to omit sharing icons. **Example:** <code>"sharing_icons": false</code>
    - `updated_at` string, date-time — The date and time the real-time stream was updated.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `410` — Gone

---

[API](https://skmtc.net/wowza/apis/wowza-video-rest-api-reference-documentation.md) · [All operations](https://skmtc.net/wowza/apis/wowza-video-rest-api-reference-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wowza/wowza-video-rest-api-reference-documentation/versions/157b6f741f2a/schema)