# Feed

## Description

Endpoint for fetching press releases. Support filtering by query params like (`type`, `tag`, `lang`, etc) and pagination using `offset`/`limit`.

By default 48 items are fetched unless the `limit` query param is used, max `limit` is 500. The feed contains automatically calculated URLs with offset/limit for pagination in the `next_url`/`prev_url` fields.

The `feed_id` is provided by us when initiating the integration.

All items returned according to the following model

{% content-ref url="/pages/-MbD4Fce\_hJLYPE002Kh" %}
[Model](/mfn-integration-guide/-MbDBLBpI3LuyvwyWLVw/api/model.md)
{% endcontent-ref %}

All allowed query params are documented below (click to expand)

## Get Press Release Feed

<mark style="color:blue;">`GET`</mark> `https://feed.mfn.se/v1/feed/:feed_id[.format]`

Returns a feed of press releases filtered by the query params. Available in both JSON (default) and XML formats. Use `.json` or `.xml` to select format.

#### Path Parameters

| Name                                       | Type   | Description                                                                     |                  |
| ------------------------------------------ | ------ | ------------------------------------------------------------------------------- | ---------------- |
| feed\_id<mark style="color:red;">\*</mark> | string | <p>Feed Id<br>Provided by MFN Team</p>                                          |                  |
| format                                     | string | <p>Format of the feed to return. Defaults to <code>json</code><br><code>\[ json | xml ]</code></p> |

#### Query Parameters

| Name           | Type    | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| -------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| type           | string  | Press release type `[ ir \| pr ]`                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| tag            | string  | <p>Include items that matches tag</p><p>Examples:<br><code>All Reports</code>  <br><code>tag=sub:report</code>  <br><code>Annual Reports</code>  <br><code>tag=sub:report:annual</code>  <br><code>Regulatory releases</code>  <br><code>tag=:regulatory</code></p>                                                                                                                                                                                                                 |
| lang           | string  | Filter items by lang (ISO 639-1 two-letter lang code)                                                                                                                                                                                                                                                                                                                                                                                                                               |
| filter         | string  | Advanced filtering                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| query          | string  | <p>Basic text search<br><em>Currently uses no stemming or fuzzy search</em><br><br>The feed query search applies prefix matching. For example the search <em>query=share</em> would find texts containing words starting with or equal to <em>share</em> like <em>share</em> and <em>shareholder</em> but not words where the query is contained or postfixed like <em>timeshare</em>.<br><br>The results are then returned ordered by the frequency of their matching lexemes.</p> |
| from           | string  | <p>Returns items with a <code>.content.publish\_date</code> above this date. RFC3339 formatted.<br>Note: needs to be URL formatted.Example:<br><code>RFC3339 Input:</code>  <br><code>2021-01-01T00:00:00Z</code>  <br><code>Query param:</code>  <br><code>from=2021-01-01T00%3A00%3A00Z</code></p>                                                                                                                                                                                |
| to             | string  | <p>Returns items with a <code>.content.publish\_date</code> below this date. RFC3339 formatted.<br>Note: needs to be URL formatted.Example:<br><code>RFC3339 Input:</code>  <br><code>2021-12-31T23:59:59Z</code>  <br><code>Query Param:</code>  <br><code>to=2021-12-31T23%3A59%3A59Z</code></p>                                                                                                                                                                                  |
| source         | string  | Press release source                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| news-slug      | string  | <p>Filter by the specified news item slug.<br>This is the <code>.content.slug</code> field of a News Item</p>                                                                                                                                                                                                                                                                                                                                                                       |
| group-id       | string  | <p>Filter by the specified <code>group\_id</code><br><em>If the content is tagged correctly this should return all news items belonging to the same group. Basically all language versions of the same press release.</em></p>                                                                                                                                                                                                                                                      |
| news-id        | string  | <p>Filter by the specified<code>news\_id</code><br><em>Note: will only return one item</em></p>                                                                                                                                                                                                                                                                                                                                                                                     |
| compact        | boolean | Return less data. Leaves out `content.html`                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| offset         | number  | Offset the feed by this many items                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| limit          | number  | <p>How many items to return.<br>Maximum is 500.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| not-tag        | String  | Include items except those matching tag                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| ext-properties | boolean | `ext-properties=true` shows total amount of releases in feed                                                                                                                                                                                                                                                                                                                                                                                                                        |

{% tabs %}
{% tab title="200 JSON Feed example" %}

```
{
  "version": "https://www.mfn.se/feed/version/1",
  "home_page_url": "https://feed.mfn.se/v1/feed/2c07a2db-2f22-4a67-ab46-ccb464296638",
  "feed_url": "https://feed.mfn.se/v1/feed/2c07a2db-2f22-4a67-ab46-ccb464296638",
  "next_url": "https://feed.mfn.se/v1/feed/2c07a2db-2f22-4a67-ab46-ccb464296638?limit=48&offset=48",
  "items": [
    {
      "news_id": "0c929408-c553-4a3b-b529-15e17f9db2e0",
      "group_id": "673ec417-cae7-41e8-a19f-d02b5c79d1fd",
      "url": "https://feed.mfn.se/v1/item/0c929408-c553-4a3b-b529-15e17f9db2e0.html",
      "author": {
        "entity_id": "2c07a2db-2f22-4a67-ab46-ccb464296638",
        "slug": "modfin",
        "slugs": [
          "modfin",
          "modular-finance-ab"
        ],
        "name": "Modular Finance AB",
        "brand_image_url": "https://storage.mfn.se/c51c5561-0f94-49f0-a6de-f1e65b427898"
      },
      "subjects": [
        {
          "entity_id": "2c07a2db-2f22-4a67-ab46-ccb464296638",
          "slug": "modfin",
          "slugs": [
            "modfin",
            "modular-finance-ab"
          ],
          "name": "Modular Finance AB",
          "brand_image_url": "https://storage.mfn.se/c51c5561-0f94-49f0-a6de-f1e65b427898"
        }
      ],
      "properties": {
        "lang": "en",
        "tags": [
          ":regulatory",
          ":regulatory:mar",
          "sub:report",
          "sub:report:interim",
          "sub:report:interim:q1",
          "cus:mfn"
        ],
        "type": "ir",
        "scopes": [
          "SE"
        ]
      },
      "content": {
        "title": "Interim Report Jan-Mar Q1 2021",
        "slug": "interim-report-jan-mar-q1-2021",
        "publish_date": "2021-04-26T09:06:00Z",
        "html": "<div class=\"mfn-preamble\"><p><strong>After a strong quarter, ... ",
        "attachments": [
          {
            "file_title": "Interim Report Q1",
            "content_type": "application/pdf",
            "url": "https://storage.mfn.se/8cc49f8c-6a72-45ef-9ec6-7e81ebd90001/interim-report-q1.pdf",
            "tags": [
              ":generated",
              ":primary"
            ]
          }
        ]
      },
      "extensions": {},
      "source": "mfn"
    }
  ]
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://modfin.gitbook.io/mfn-integration-guide/-MbDBLBpI3LuyvwyWLVw/api/feed.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
