---
title: "Live feed (SSE)"
method: GET
path: "/v1/streams/live"
tags: ["Webhooks"]
---

# Live feed (SSE)

`GET /v1/streams/live`

## Request

- Base URL: `https://api.sonovault.now`
- URL: `https://api.sonovault.now/v1/streams/live`
- Auth: API key in header `x-api-key`

A Server-Sent Events stream of your stream-play events in real time, across all your streams, the push alternative to polling now-playing. This is the low-latency feed: it fires the moment a track is detected, so unlike webhooks it is not settled first and a detection can occasionally resolve differently a moment later. Use it to drive a live now-playing display, and webhooks for the confirmed log. Each message is an SSE `event:` line (`stream.play.started`) with the event JSON in `data:`. Authenticate with the `x-api-key` header; in the browser, proxy this through your own server so the key isn't exposed (the EventSource API can't send headers). Bundled with stream monitoring (no API credits).

## Response `200`

Successful response

- StreamPlayEvent: The event body pushed to a webhook endpoint and over the SSE feed.
  - `id` string, required: Event ID. Stable across webhook retries; dedupe on it.
  - `type` 'stream.play.started' | 'stream.offline' | 'stream.online', required: Event type. The `data` payload differs per type.
  - `created` string, required: When the event was emitted, ISO-8601 UTC.
  - `data` object, required: The event payload.
    - `stream_id` string, required: The stream the event belongs to.
    - `started_at` string, required: When the airing began, ISO-8601 UTC. On `stream.offline` / `stream.online` this is `at` instead.
    - `track` Track, required: The public track shape, returned by search, ISRC/ID lookup, browse and resolve. Tempo (`bpm`) and musical key come from our own analysis of the audio; other audio features (energy, danceability, popularity) are not part of the public API.
      - `id` integer, required: Sonovault track ID. Stable, and the id every other endpoint takes.
      - `title` string, required: Track title, including any mix or version suffix.
      - `releases` TrackRelease[], required: The release we treat as representative for this recording, as a one-element array. We pick it by release type, then a title match, then earliest date, so a track that appeared on twenty compilations still reports the release it belongs to.
        - `id` integer, required: Release ID. Use it with `GET /v1/releases/:id`.
        - `title` string, required: Release title.
        - `artist` ArtistRef, required: A minimal artist reference. Artists are always nested objects on the public API, never a flat `artist_name` column.
          - `id` integer, required: Artist ID.
          - `name` string, required: Artist name.
        - `label` LabelRef, required: A minimal label reference.
          - `id` integer, required: Label ID.
          - `name` string, required: Label name.
        - `release_date` string, nullable, required: Release date, `YYYY-MM-DD`. `null` when unknown.
      - `artists` TrackArtist[], required: Artist credits, primary artists first.
        - `id` integer, required: Artist ID. Use it with `GET /v1/artists/:id`.
        - `name` string, required: Artist name as credited.
        - `is_primary` boolean, required: `true` for a main artist, `false` for a featured or supporting credit.
        - `is_remixer` boolean, required: `true` when the credit is for a remix of the track.
      - `isrc` string, nullable, required: One representative ISRC. A recording often has several (radio edit, reissue, regional release); look them all up with `GET /v1/tracks/isrc/:isrc`. `null` when no ISRC is known.
      - `duration` integer, nullable, required: Duration in seconds. `null` when unknown.
      - `bpm` number, nullable, required: Tempo in beats per minute, up to two decimals (e.g. `123`, `123.48`). Measured by the Lexicon DJ beat detector on the audio itself, and reported at full tempo: a drum & bass track reads `174`, not the half-time `87`. `null` when the track has not been analysed yet.
      - `key_alphanumeric` string, nullable, required: Musical key in alphanumeric notation: a number from 1 to 12 plus `A` for minor or `B` for major (e.g. `10B`). Keys one step apart on the wheel, or with the same number, mix harmonically. Our preferred key, measured by OpenKeyScan. `null` when the track has not been analysed yet.
      - `key_musical` string, nullable, required: The same key in standard musical notation (e.g. `D`, `Am`, `F#m`, `Ebm`, `Db`). A trailing `m` means minor. `null` when the track has not been analysed yet.
      - `key_open` string, nullable, required: The same key in Open Key notation, lowercase: a number from 1 to 12 plus `d` for major or `m` for minor (e.g. `3d`, `1m`). `null` when the track has not been analysed yet.
      - `keys` TrackKey[], required: Every key we hold for the track, one entry per source, each in all three notations. The single `key_*` fields carry the preferred entry. Empty array when the track has not been analysed yet.
        - `key_alphanumeric` string, required: Alphanumeric notation, e.g. `10B` (1-12, `A` minor, `B` major).
        - `key_musical` string, required: Standard musical notation, e.g. `D`, `F#m`.
        - `key_open` string, required: Open Key notation, lowercase, e.g. `3d` (major) or `1m` (minor).
        - `source` string, required: Who measured this key. Currently always `openkeyscan` (our own analysis with OpenKeyScan). More sources may be added, so treat unknown values as valid.
      - `genre` string[], required: Canonical genres. Empty array when the track is unclassified.
      - `subgenre` string[], required: Canonical subgenres. Empty array when none apply.

---

[API](https://skmtc.dev/sonovault/apis/sonovault-api.md) · [All operations](https://skmtc.dev/sonovault/apis/sonovault-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sonovault/apis/sonovault-api/revisions/0152fff23f2c?raw)