Skip to content
Platform docs
Auth, users, webhooks & more

Search for Feeds

The query feeds endpoint lets you search for feeds.

Examples

Querying My Feeds

# First page query
first_page = client.feeds.query_feeds(
  GetStream::Generated::Models::QueryFeedsRequest.new(
    filter: { "created_by_id" => "john" },
    limit: 10,
    sort: [{ "field" => "created_at", "direction" => -1 }]
  )
)

# Second page using next cursor from first page
if first_page.next
  second_page = client.feeds.query_feeds(
    GetStream::Generated::Models::QueryFeedsRequest.new(
      filter: { "created_by_id" => "john" },
      limit: 10,
      sort: [{ "field" => "created_at", "direction" => -1 }],
      next: first_page.next
    )
  )
end

Querying Feeds Where I Am a Member

response = client.feeds.query_feeds(
  GetStream::Generated::Models::QueryFeedsRequest.new(
    filter: {
      "members" => { "$in" => ["john"] }
    }
  )
)

Querying feeds by name or description

# Search public feeds by name
response1 = client.feeds.query_feeds(
  GetStream::Generated::Models::QueryFeedsRequest.new(
    filter: {
      "visibility" => { "$eq" => "public" },
      "name" => { "$q" => "Sports" }
    }
  )
)

# Search public feeds by description
response2 = client.feeds.query_feeds(
  GetStream::Generated::Models::QueryFeedsRequest.new(
    filter: {
      "visibility" => "public",
      "description" => { "$q" => "tech" }
    }
  )
)

Querying feeds by creator name

response = client.feeds.query_feeds(
  GetStream::Generated::Models::QueryFeedsRequest.new(
    filter: {
      "visibility" => "public",
      "created_by.name" => { "$q" => "Thompson" }
    }
  )
)

A complex example

Search for user feeds where text matches the feed's name, description or creator's name:

response = client.feeds.query_feeds(
  GetStream::Generated::Models::QueryFeedsRequest.new(
    filter: {
      "group_id" => "user",
      "$or" => [
        { "name" => { "$q" => search_query } },
        { "description" => { "$q" => search_query } },
        { "created_by.name" => { "$q" => search_query } }
      ]
    }
  )
)

Feeds Queryable Built-in Fields

name type description supported operations example
id string or list of strings The ID of the feed $in, $eq { id: { $in: [ 'abc', 'xyz' ] } }
group_id string or list of strings The ID of the group this feed belongs to $in, $eq { group_id: { $in: [ 'abc', 'xyz' ] } }
feed string or list of strings The fully qualified feed ID (group_id:id) $in, $eq { fid: { $in: [ 'abc', 'xyz' ] } }
visibility string or list of strings The visibility setting of the feed $in, $eq { visibility: { $eq: 'public' } }
created_by_id string or list of strings The ID of the user who created the feed $in, $eq { created_by_id: { $in: [ 'abc', 'xyz' ] } }
created_by.name string The name of the user who created the feed $eq, $q, $autocomplete { 'created_by.name': { $autocomplete: 'Frank' } }
name string The name of the feed $eq, $q, $autocomplete { name: { $q: 'Sports' } }
description string The description of the feed $eq, $q, $autocomplete { description: { $autocomplete: 'tech' } }
member_count number The number of accepted members in this feed (pending and declined invitations are not counted) $eq, $ne, $gt, $lt, $gte, $lte { member_count: { $gt: 100 } }
members list of strings The list of members in this feed $in { members: { $in: [ 'bob', 'alice' ] } }
following_count number The number of feeds this feed follows $eq, $ne, $gt, $lt, $gte, $lte { following_count: { $gt: 100 } }
following_feeds list of strings The list of feeds this feed follows $in { following_feeds: { $in: [ 'feed1', 'feed2' ] } }
follower_count number The number of followers of this feed $eq, $ne, $gt, $lt, $gte, $lte { follower_count: { $gt: 100 } }
created_at string, RFC3339 timestamp The time the feed was created $eq, $gt, $lt, $gte, $lte { created_at: { $gte: '2023-12-04T09:30:20.45Z' } }
updated_at string, RFC3339 timestamp The time the feed was updated $eq, $gt, $lt, $gte, $lte { updated_at: { $gte: '2023-12-04T09:30:20.45Z' } }
filter_tags list of strings Tags for filtering the feed $eq, $contains, $in { filter_tags: { $in: [ 'sports', 'news' ] } }
near object GEO point and distance (km) to filter by $eq { near: { $eq: { lat: 40.0, lng: -74.0, distance: 200 } } }
within_bounds object GEO bounding box to filter by $eq { within_bounds: { $eq: { ne_lat: 40.0, ne_lng: -115.0, sw_lat: 32.0, sw_lng: -125.0 } } }

Filter expressions can be combined using $or and $and operators as well.

Feeds can be sorted by created_at, updated_at, member_count, follower_count, and following_count.

Be sure to reach out to support if you need additional query feed capabilities.