Streams

Stream status + now playing

Get a stream's status and the track playing right now. now_playing is null during ad breaks, talk, or unrecognised audio. The track is a plain track object, the same shape as search results.

Requires a paid plan: the free tier returns 403 for this endpoint.

get/v1/streams/{id}

Request

  • Base URL: https://api.sonovault.now
  • URL: https://api.sonovault.now/v1/streams/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Stream id from registration.

Response

Successful response

idstring required

Stream ID.

urlstring required

The audio stream URL being monitored.

namestring nullable required

Your label for the stream. null when you did not set one.

status'active' | 'stopped' required

Whether the stream is still being monitored and billed.

detection_mode'precise' | 'balanced' | 'broad' required

The accuracy/coverage target the matcher tunes toward.

outage_notificationsboolean required

Whether outage emails are on for this stream.

created_atstring required

When the stream was registered, ISO-8601 UTC.

stopped_atstring nullable required

When it was stopped, ISO-8601 UTC. null while active.

runtime_statusstring required

What the monitor is doing right now, as opposed to what you asked for: pending, running, errored or stopped. It falls back to status when the monitor cannot be reached.

last_recognized_atstring nullable required

When we last recognised anything on this stream, ISO-8601 UTC. null if nothing ever has been.

status_reasonstring nullable required

Why the stream is in its current runtime_status, in plain language (an auth wall on the broadcast host, for instance). null unless the monitor reports one.

formatstring nullable required

The recognition tuning hint in force: electronic, classical, pop, or null for auto, which runs every recogniser.

Changes

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