Get List (find)

Request to fetch stream list.

Request

Property	Value
Method	`GET`
URL	`https://api.stormstreaming.com/api/request/stream/list`
Authentication	`x-api-key`

Request

bash

curl -X GET "https://api.stormstreaming.com/api/request/stream/list?query=my+stream&page=1&rowsPerPage=10" \
  -H "x-api-key: YOUR_API_KEY"

Query Parameters

Field	Default	Required	Validation	Description
`query`	-	No	String 1-255 chars	Flexible search field. Smart and typo-tolerant phrase matching
`page`	1	No	Int	Current list page
`rowsPerPage`	10	No	Int 5-50	Maximum rows per page
`order`	desc	No	String asc/desc	'desc' for newest first, 'asc' for oldest first
`orderBy`	createDate	No	String createDate/streamName/isPublished	Column to sort by

Request Body

json

{
  "query": "my stream",
  "page": 1,
  "rowsPerPage": 10,
  "order": "desc",
  "orderBy": "createDate"
}

Response

Parameter	Type	Description
`list`	array	Array of stream objects
`list[].streamKey`	string (40 chars)	Stream unique key
`list[].name`	string (1-255 chars)	Stream name
`list[].thumbUrl`	string (nullable)	URL of the thumbnail image
`list[].isPublished`	boolean	Whether the stream is currently live
`list[].createDate`	string	Creation date (Y-m-d H:i:s)
`list[].highlight`	string (nullable)	Search terms enclosed in `<mark>` tags
`totalCount`	integer	Total number of streams matching the query

Successful Response (200)

json

{
  "list": [
    {
      "streamKey": "9ed8b119f8ed9425a428a47846e55c6b761afc6c",
      "name": "My stream",
      "thumbUrl": null,
      "isPublished": true,
      "createDate": "2024-01-25 11:10:53",
      "highlight": [
        "My <mark>stream</mark>"
      ]
    },
    {
      "streamKey": "f429ebe038d866ff88223498f467f59f9e7c365d",
      "name": "My stream 2",
      "thumbUrl": null,
      "isPublished": false,
      "createDate": "2024-01-25 11:03:05",
      "highlight": [
        "My <mark>stream</mark> 2"
      ]
    }
  ],
  "totalCount": 2
}

Support Needed?

Create a free ticket and our support team will provide you necessary assistance.