Return to Developer Console

Streams

List current Smart Streams

https://feedwrangler.net/api/v2/streams/list
Name Required Notes
access_token YES
Success:
{
    "streams":
        [
            {
                "stream_id":12,
                "title":"Simple Stream",
                "all_feeds":true,
                "only_unread":false,
                "search_term":"Apple",
                "feeds":[]
            },
            {
                "stream_id":11,
                "title":"Complex Stream",
                "all_feeds":false,
                "only_unread":true,
                "search_term":"iPhone",
                "feeds":
                    [
                        {
                            "title":"Daring Fireball",
                            "feed_id":290,
                            "feed_url":"http://daringfireball.net/index.xml"
                        }
                    ]
            }
        ],
    "error":null,
    "result":"success"
}

Retrieve the current feed_items in a Smart Stream

https://feedwrangler.net/api/v2/streams/stream_items
Name Required Notes
access_token YES
stream_id YES
limit NO Maximum number of items to return, default 100, max 100
offset NO Number of items to skip before returning results, default 0
Success:
    {
        "count":2,
        "feed_items":
            [
                {
                    "feed_item_id":8046,
                    "published_at":1367362441,
                    "created_at":1367416779,
                    "updated_at":1367864007,
                    "version_key":1367864007,
                    "url":"https://medium.com/what-i-learned-building/9216e1c9da7d",
                    "title":"The McDonald’s Theory of Bad Ideas",
                    "starred":false,
                    "read":true,
                    "read_later":false,
                    "body":"...",
                    "author":"John Gruber",
                    "feed_id":290,
                    "feed_name":"Daring Fireball"
                },
                {
                    "feed_item_id":8045,
                    "published_at":1367380295,
                    "created_at":1367416779,
                    "version_key":1367867655,
                    "updated_at":1367867655,
                    "url":"http://daringfireball.net/2013/04/web_apps_native_apps",
                    "title":"★ Web Apps vs. Native Apps Is Still a Thing",
                    "starred":true,
                    "read":true,
                    "read_later":false,
                    "body":"...",
                    "author":"John Gruber",
                    "feed_id":290,
                    "feed_name":"Daring Fireball"
                }
            ],
        "error":null,
        "result":"success"
    }

Retrieve the feed_item_ids of the items in a Smart Stream

https://feedwrangler.net/api/v2/streams/stream_item_ids
Name Required Notes
access_token YES
stream_id YES
Success:
{
    "count":1,
    "feed_items":
    [
        {
            "feed_item_id":8055,
            "updated_at":1367864007
        }
    ],
    "error":null,
    "result":"success"
}

Create new Smart Stream

https://feedwrangler.net/api/v2/streams/create
Name Required Notes
access_token YES
title YES The name of the Smart Stream, must be unique for user
search_term NO The search filter to apply to the stream
all_feeds NO true or false, should stream include all subscribed feeds. Overrides feed_ids. Default true
only_unread NO true or false, stream should only include unread items. Default true
feed_ids NO Comma separated list of feed_ids to include in this stream.
Success:
{
    "result":"success",
    "stream":{
        "stream_id":25,
        "title":"Example",
        "all_feeds":true,
        "only_unread":true,
        "search_term":null,
        "feeds":[]
    }
    "error":null
}

Update existing Smart Stream

https://feedwrangler.net/api/v2/streams/update

Parameters not included in the request are not updated.

Name Required Notes
access_token YES
stream_id YES The ID of the stream to update
title NO The name of the Smart Stream, must be unique for user
search_term NO The search filter to apply to the stream
all_feeds NO true or false, should stream include all subscribed feeds.
only_unread NO true or false, stream should only include unread items.
feed_ids NO Comma separated list of feed_ids to include in this stream.
Success:
{
    "result":"success",
    "stream":{
        "stream_id":25,
        "title":"ExampleUpdated",
        "all_feeds":true,
        "only_unread":true,
        "search_term":null,
        "feeds":[]
    }
    "error":null
}

Destroy existing Smart Stream

https://feedwrangler.net/api/v2/streams/destroy
Name Required Notes
access_token YES
stream_id YES The ID of the stream to update
Success:
{
    "result":"success",
    "error":null
}


Developer Inquiries