To use the HotMic Public API, you need to use a public API key provided by HotMic.

Retrieve Stream(s) Endpoint

x-api-key

Limits the number of results returned by the query. Defaults to 100.

limit

Filter results to only include streams with a given state. Can be: "SCHEDULED", "LIVE", "ENDED", or "VOD"

state

Filter results to only include streams with a certain userId.

userId

Filter results to only include 1 or more streams by id. If passing multiple ids, separate them by an underscore _. (example: abc-123_def-456 would filter for 2 streams "abc-123" and "def-456").

The field to order by, ascending by default

orderBy

If true, order by descending instead of ascending.

desc

This filters the results to only return the next results after this cursor, up to the limit. Typically used for pagination, this is the last result that will be ignored based on the orderBy field. So if you are sorting by ids, and you have 5 users with id 1,2,3,4,5: passing cursor=2 limit=2 would return 3,4. 
Do not use combined with "skip".

cursor

When paginating, how many results to skip. If using skip 30 limit 10, you would get results 31 to 40. Do not use combined with "cursor".

skip

Defaults to "skip". If this is set to "cursor", then the "next" result on the link will always return the correct next paginated result using a cursor.

pagination

https://public-api.hotmic.io/streams?limit=1000

Get next set of 1000 Streams (provided by “$.links.next” in response

https://public-api.hotmic.io/streams?cursor=a3113c5b-26f5-4704-aa43-288446d250b6&limit=1000

https://public-api.hotmic.io/streams?ids=e35a851b-e161-46b7-a921-f6899ccb9cc0_0e246a7b-1a14-4028-aac6-a2f0433bd8c7

Get all Streams for specific User ID (default limit)

https://public-api.hotmic.io/streams?userId=e35a851b-e161-46b7-a921-f6899ccb9cc0

https://public-api.hotmic.io/streams?orderBy=last_updated&cursor=2022-10-13T17:00:08Z

Returns the stream object if the update succeeded. Returns an error if there the update fails.

Update stream information, such as title or invite link.

Update Stream Endpoint

title

Update the user_id of the owner of the stream in HotMic. Note, this must be a valid HotMic user_id.

user_id

Update the url to the stream thumbnail of used in HotMic. Note: the url must be publically accessible if updating in this way.

thumbnail

Update the scheduled_date of the stream. Dates are in ISO-8601 format, for example: "2019-09-08T00:00:00.000+00:00".

scheduled_date

description

The invite link is the link to the stream. If you generate a link for the event, use this to update the link for the hosts to see. This doesn't change the link to the event itself, rather the link for the hosts to view.

invite_link

Update user information, such as their name or the default invite link for their profile.

Update User Endpoint

name

email

The default_invite_link of the user to modify

default_invite_link

General tags are added, edited, and returned with the user object when it is returned in the API. This allows you to add information for future use. 

authorized_stream_tags

Create User Endpoint

display_name

A URL to show for the user as a profile picture in chats and other areas.