diff --git a/API.md b/API.md index d32f769..352b139 100644 --- a/API.md +++ b/API.md @@ -4,9 +4,10 @@ As of API version 0.2, there are two API endpoints: ## List of active streams You can query for a list of active streams, by sending a GET request to `localhost:8080/api/streams/` + Here's an example query and the expected result: -`$ curl http://localhost:8080/api/v0.2/streams/` +`$ curl http://localhost:8080/api/v0.2/streams/`\ Response example: ```json { @@ -22,7 +23,8 @@ i.e. There are two active streams in the `live` app, namely foo and bar. More in ## Query Stream information If you know the app and name of the stream you want to query, you can request more information,with a query like this: -`$ curl http://localhost:8080/api/v0.2/streams/foo/` + +`$ curl http://localhost:8080/api/v0.2/streams/foo/`\ Response example: ```json { @@ -36,5 +38,4 @@ Response example: ] } } - ```