> For the complete documentation index, see [llms.txt](https://docs.fyuz.fun/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fyuz.fun/api-reference/live-streaming.md).

# Live Streaming

Creator broadcast sessions and viewer access on token pages.

## 🔏 Go live

> Creator-only. Starts a broadcast on the creator's token page and returns a publisher access token.

```json
{"openapi":"3.1.0","info":{"title":"Fyuz API","version":"1.0.0"},"tags":[{"name":"Live Streaming","description":"Creator broadcast sessions and viewer access on token pages."}],"servers":[{"url":"https://api.fyuz.fun","description":"Production"}],"paths":{"/stream/start":{"post":{"tags":["Live Streaming"],"summary":"🔏 Go live","description":"Creator-only. Starts a broadcast on the creator's token page and returns a publisher access token.","operationId":"streamStart","requestBody":{"$ref":"#/components/requestBodies/Signed"},"responses":{"200":{"description":"Publisher token."}}}}},"components":{"requestBodies":{"Signed":{"description":"Wallet-signed action payload.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["address","message","signature"],"properties":{"address":{"type":"string","description":"Acting wallet."},"message":{"type":"string","description":"The signed message (includes a timestamp for replay protection)."},"signature":{"type":"string","description":"Signature of the message by the wallet."}}}}}}}}}
```

## 🔏 End the stream

> Creator-only.

```json
{"openapi":"3.1.0","info":{"title":"Fyuz API","version":"1.0.0"},"tags":[{"name":"Live Streaming","description":"Creator broadcast sessions and viewer access on token pages."}],"servers":[{"url":"https://api.fyuz.fun","description":"Production"}],"paths":{"/stream/stop":{"post":{"tags":["Live Streaming"],"summary":"🔏 End the stream","description":"Creator-only.","operationId":"streamStop","requestBody":{"$ref":"#/components/requestBodies/Signed"},"responses":{"200":{"description":"Stream ended."}}}}},"components":{"requestBodies":{"Signed":{"description":"Wallet-signed action payload.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["address","message","signature"],"properties":{"address":{"type":"string","description":"Acting wallet."},"message":{"type":"string","description":"The signed message (includes a timestamp for replay protection)."},"signature":{"type":"string","description":"Signature of the message by the wallet."}}}}}}}}}
```

## Stream status

> Live flag, start time and viewer count for a token.

```json
{"openapi":"3.1.0","info":{"title":"Fyuz API","version":"1.0.0"},"tags":[{"name":"Live Streaming","description":"Creator broadcast sessions and viewer access on token pages."}],"servers":[{"url":"https://api.fyuz.fun","description":"Production"}],"paths":{"/stream/{tokenAddress}":{"get":{"tags":["Live Streaming"],"summary":"Stream status","description":"Live flag, start time and viewer count for a token.","operationId":"streamStatus","parameters":[{"$ref":"#/components/parameters/tokenAddress"}],"responses":{"200":{"description":"Status.","content":{"application/json":{"schema":{"type":"object","properties":{"isLive":{"type":"boolean"},"startedAt":{"type":"string"},"viewers":{"type":"integer"}}}}}}}}}},"components":{"parameters":{"tokenAddress":{"name":"tokenAddress","in":"path","required":true,"schema":{"type":"string"},"description":"Token address (hex)."}}}}
```

## Join as viewer

> Returns a subscribe-only access token for watching the stream.

```json
{"openapi":"3.1.0","info":{"title":"Fyuz API","version":"1.0.0"},"tags":[{"name":"Live Streaming","description":"Creator broadcast sessions and viewer access on token pages."}],"servers":[{"url":"https://api.fyuz.fun","description":"Production"}],"paths":{"/stream/{tokenAddress}/join":{"get":{"tags":["Live Streaming"],"summary":"Join as viewer","description":"Returns a subscribe-only access token for watching the stream.","operationId":"streamJoin","parameters":[{"$ref":"#/components/parameters/tokenAddress"},{"name":"address","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Viewer token."}}}}},"components":{"parameters":{"tokenAddress":{"name":"tokenAddress","in":"path","required":true,"schema":{"type":"string"},"description":"Token address (hex)."}}}}
```

## Viewer heartbeat

> Keeps the live viewer count accurate while watching.

```json
{"openapi":"3.1.0","info":{"title":"Fyuz API","version":"1.0.0"},"tags":[{"name":"Live Streaming","description":"Creator broadcast sessions and viewer access on token pages."}],"servers":[{"url":"https://api.fyuz.fun","description":"Production"}],"paths":{"/stream/{tokenAddress}/heartbeat":{"post":{"tags":["Live Streaming"],"summary":"Viewer heartbeat","description":"Keeps the live viewer count accurate while watching.","operationId":"streamHeartbeat","parameters":[{"$ref":"#/components/parameters/tokenAddress"}],"responses":{"200":{"description":"Acknowledged."}}}}},"components":{"parameters":{"tokenAddress":{"name":"tokenAddress","in":"path","required":true,"schema":{"type":"string"},"description":"Token address (hex)."}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.fyuz.fun/api-reference/live-streaming.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.