Skip to main content
Interact with Ducky Radio and control compatible providers via HTTP.Continue reading for an introduction to the Ducky Radio API

​
Authentication

There no authentication required. Ducky Radio is designed to run and be accessed locally.
Although no tokens or API keys are required, all POST endpoints require a specific header to be set to an arbitrary value, outlined in the documentation for each endpoint.

​
Connection Info

Ducky Radio runs on port 1234 by default
Once running, the API can be accessed at http://localhost:1234/api

​
Sending your First Request

Once Ducky Radio is running, you can test the API’s functionality with a simple GET request.
1

Play Music

Play a song using the connected provider of your choice. If you can view the ducky radio logs, wait for the newTrack event to be fired before continuing.
2

Send GET Request

Run the following command in the terminal of your choice
curl --request GET \
--url http://localhost:1234/api/tracks/nowplaying
3

😎 Observe

You should receive a JSON response. It will either be a Track object, or an object with an error string.See Endpoint Documentation

​
Next Steps

Once you’ve got the API up and running, continue to the Endpoints section to learn about all of the ways to interact with Ducky Radio over HTTP

API Endpoints