> Markdown versions of all pages of this connector library are available by appending `.md` to the page URL. For the full index of connectors, see [llms.txt](https://connectors.appmixer.com/llms.txt).

# appmixer.utils.rss.GetFeed

- Component: `appmixer.utils.rss.GetFeed`
- Kind: Action
- Version: 1.0.0
- Visibility: Public
- Connector: [appmixer.utils.rss 1.2.0](https://connectors.appmixer.com/connector/appmixer.utils.rss/1.2.0.md)
- Component page: <https://connectors.appmixer.com/connector/appmixer.utils.rss/1.2.0/component/appmixer.utils.rss.GetFeed>

Get a RSS feed.

## Input ports

### Port `in`

| Field | Type | Description |
| --- | --- | --- |
| URL (`url`) | text | A URL to a RSS feed. Example `https://www.nasa.gov/rss/dyn/breaking_news.rss`. |
| Max Age (hours) (`maxAgeHours`) | number | Only return items published within this many hours. Items without a publication date are left out. Leave empty to return all items. |
| Max Items (`maxItems`) | number | Maximum number of items to return, in feed order (usually newest first). Leave empty for no limit. |
| Include Full Content (`includeContent`) | toggle | Turn off to drop the full article body (`content`, `content:encoded`, `summary`) and shorten `contentSnippet` to 500 characters. Use it for feeds that publish whole articles, whose output can otherwise exceed the message size limit. |

## Output ports

### Port `out`

| Field | Type | Description |
| --- | --- | --- |
| Feed (`feed`) | object | - |
| Feed URL (`feed.feedUrl`) | string | - |
| Feed Title (`feed.title`) | string | - |
| Feed Description (`feed.description`) | string | - |
| Feed Link (`feed.link`) | string | - |
| Feed Items (`feed.items`) | array | - |
| Feed Image Link (`feed.image.link`) | string | - |
| Feed Image URL (`feed.image.url`) | string | - |
| Feed Image Title (`feed.image.title`) | string | - |

## Full metadata (component.json)

```json
{
  "name": "appmixer.utils.rss.GetFeed",
  "author": "David Durman <david@client.io>",
  "description": "Get a RSS feed.",
  "inPorts": [
    {
      "name": "in",
      "schema": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string",
            "format": "uri"
          },
          "maxAgeHours": {
            "type": "number",
            "exclusiveMinimum": 0
          },
          "maxItems": {
            "type": "integer",
            "minimum": 1
          },
          "includeContent": {
            "type": "boolean"
          }
        },
        "required": [
          "url"
        ]
      },
      "inspector": {
        "inputs": {
          "url": {
            "type": "text",
            "label": "URL",
            "index": 1,
            "tooltip": "A URL to a RSS feed. Example <code>https://www.nasa.gov/rss/dyn/breaking_news.rss</code>."
          },
          "maxAgeHours": {
            "type": "number",
            "label": "Max Age (hours)",
            "index": 2,
            "tooltip": "Only return items published within this many hours. Items without a publication date are left out. Leave empty to return all items."
          },
          "maxItems": {
            "type": "number",
            "label": "Max Items",
            "index": 3,
            "tooltip": "Maximum number of items to return, in feed order (usually newest first). Leave empty for no limit."
          },
          "includeContent": {
            "type": "toggle",
            "label": "Include Full Content",
            "index": 4,
            "defaultValue": true,
            "tooltip": "Turn off to drop the full article body (<code>content</code>, <code>content:encoded</code>, <code>summary</code>) and shorten <code>contentSnippet</code> to 500 characters. Use it for feeds that publish whole articles, whose output can otherwise exceed the message size limit."
          }
        }
      }
    }
  ],
  "outPorts": [
    {
      "name": "out",
      "options": [
        {
          "label": "Feed",
          "value": "feed",
          "schema": {
            "type": "object",
            "example": {
              "items": [
                {
                  "title": "Introducing the new reporting API",
                  "link": "https://example.com/blog/new-reporting-api",
                  "pubDate": "Fri, 15 Mar 2024 10:30:00 GMT",
                  "content": "<p>Today we are releasing a new reporting API.</p>",
                  "contentSnippet": "Today we are releasing a new reporting API.",
                  "guid": "https://example.com/blog/?p=1001",
                  "categories": [
                    "Product",
                    "API"
                  ],
                  "isoDate": "2024-03-15T10:30:00.000Z"
                }
              ],
              "image": {
                "link": "https://example.com/blog",
                "url": "https://example.com/images/logo.png",
                "title": "Example Blog"
              },
              "feedUrl": "https://example.com/blog/feed.xml",
              "title": "Example Blog",
              "description": "News and updates from the Example team",
              "link": "https://example.com/blog",
              "lastBuildDate": "Fri, 15 Mar 2024 10:30:00 GMT"
            }
          }
        },
        {
          "label": "Feed URL",
          "value": "feed.feedUrl",
          "schema": {
            "type": "string",
            "example": "https://example.com/blog/feed.xml"
          }
        },
        {
          "label": "Feed Title",
          "value": "feed.title",
          "schema": {
            "type": "string",
            "example": "Example Blog"
          }
        },
        {
          "label": "Feed Description",
          "value": "feed.description",
          "schema": {
            "type": "string",
            "example": "News and updates from the Example team"
          }
        },
        {
          "label": "Feed Link",
          "value": "feed.link",
          "schema": {
            "type": "string",
            "example": "https://example.com/blog"
          }
        },
        {
          "label": "Feed Items",
          "value": "feed.items",
          "schema": {
            "type": "array",
            "example": [
              {
                "title": "Introducing the new reporting API",
                "link": "https://example.com/blog/new-reporting-api",
                "pubDate": "Fri, 15 Mar 2024 10:30:00 GMT",
                "content": "<p>Today we are releasing a new reporting API.</p>",
                "contentSnippet": "Today we are releasing a new reporting API.",
                "guid": "https://example.com/blog/?p=1001",
                "categories": [
                  "Product",
                  "API"
                ],
                "isoDate": "2024-03-15T10:30:00.000Z"
              }
            ]
          }
        },
        {
          "label": "Feed Image Link",
          "value": "feed.image.link",
          "schema": {
            "type": "string",
            "example": "https://example.com/blog"
          }
        },
        {
          "label": "Feed Image URL",
          "value": "feed.image.url",
          "schema": {
            "type": "string",
            "example": "https://example.com/images/logo.png"
          }
        },
        {
          "label": "Feed Image Title",
          "value": "feed.image.title",
          "schema": {
            "type": "string",
            "example": "Example Blog"
          }
        }
      ]
    }
  ],
  "icon": "(data URI omitted)"
}
```
